Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-recoveryservicesbackup

Index

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

AzureFileShareType

AzureFileShareType: "Invalid" | "XSMB" | "XSync"

Defines values for AzureFileShareType. Possible values include: 'Invalid', 'XSMB', 'XSync'

readonly
enum

{string}

AzureIaaSVMProtectedItemUnion

AzureIaaSVMProtectedItemUnion: AzureIaaSVMProtectedItem | AzureIaaSClassicComputeVMProtectedItem | AzureIaaSComputeVMProtectedItem

Contains the possible cases for AzureIaaSVMProtectedItem.

AzureRecoveryServiceVaultProtectionIntentUnion

AzureRecoveryServiceVaultProtectionIntentUnion: AzureRecoveryServiceVaultProtectionIntent | AzureWorkloadAutoProtectionIntentUnion

Contains the possible cases for AzureRecoveryServiceVaultProtectionIntent.

AzureVmWorkloadItemUnion

AzureVmWorkloadItemUnion: AzureVmWorkloadItem | AzureVmWorkloadSAPHanaDatabaseWorkloadItem | AzureVmWorkloadSAPHanaSystemWorkloadItem | AzureVmWorkloadSQLDatabaseWorkloadItem | AzureVmWorkloadSQLInstanceWorkloadItem

Contains the possible cases for AzureVmWorkloadItem.

AzureVmWorkloadProtectableItemUnion

AzureVmWorkloadProtectableItemUnion: AzureVmWorkloadProtectableItem | AzureVmWorkloadSAPHanaDatabaseProtectableItem | AzureVmWorkloadSAPHanaSystemProtectableItem | AzureVmWorkloadSQLAvailabilityGroupProtectableItem | AzureVmWorkloadSQLDatabaseProtectableItem | AzureVmWorkloadSQLInstanceProtectableItem

Contains the possible cases for AzureVmWorkloadProtectableItem.

AzureVmWorkloadProtectedItemUnion

AzureVmWorkloadProtectedItemUnion: AzureVmWorkloadProtectedItem | AzureVmWorkloadSAPHanaDatabaseProtectedItem

Contains the possible cases for AzureVmWorkloadProtectedItem.

AzureWorkloadAutoProtectionIntentUnion

AzureWorkloadAutoProtectionIntentUnion: AzureWorkloadAutoProtectionIntent | AzureWorkloadSQLAutoProtectionIntent

Contains the possible cases for AzureWorkloadAutoProtectionIntent.

AzureWorkloadContainerUnion

AzureWorkloadContainerUnion: AzureWorkloadContainer | AzureSQLAGWorkloadContainerProtectionContainer | AzureVMAppContainerProtectionContainer

Contains the possible cases for AzureWorkloadContainer.

AzureWorkloadRecoveryPointUnion

AzureWorkloadRecoveryPointUnion: AzureWorkloadRecoveryPoint | AzureWorkloadSQLRecoveryPointUnion

Contains the possible cases for AzureWorkloadRecoveryPoint.

AzureWorkloadRestoreRequestUnion

AzureWorkloadRestoreRequestUnion: AzureWorkloadRestoreRequest | AzureWorkloadSQLRestoreRequestUnion

Contains the possible cases for AzureWorkloadRestoreRequest.

AzureWorkloadSAPHanaRecoveryPointUnion

AzureWorkloadSAPHanaRecoveryPointUnion: AzureWorkloadSAPHanaRecoveryPoint | AzureWorkloadSAPHanaPointInTimeRecoveryPoint

Contains the possible cases for AzureWorkloadSAPHanaRecoveryPoint.

AzureWorkloadSAPHanaRestoreRequestUnion

AzureWorkloadSAPHanaRestoreRequestUnion: AzureWorkloadSAPHanaRestoreRequest | AzureWorkloadSAPHanaPointInTimeRestoreRequest

Contains the possible cases for AzureWorkloadSAPHanaRestoreRequest.

AzureWorkloadSQLRecoveryPointUnion

AzureWorkloadSQLRecoveryPointUnion: AzureWorkloadSQLRecoveryPoint | AzureWorkloadSQLPointInTimeRecoveryPoint

Contains the possible cases for AzureWorkloadSQLRecoveryPoint.

AzureWorkloadSQLRestoreRequestUnion

AzureWorkloadSQLRestoreRequestUnion: AzureWorkloadSQLRestoreRequest | AzureWorkloadSQLPointInTimeRestoreRequest

Contains the possible cases for AzureWorkloadSQLRestoreRequest.

BackupEngineBaseUnion

BackupEngineBaseUnion: BackupEngineBase | AzureBackupServerEngine | DpmBackupEngine

Contains the possible cases for BackupEngineBase.

BackupEnginesGetResponse

BackupEnginesGetResponse: BackupEngineBaseResource & object

Contains response data for the get operation.

BackupEnginesListNextResponse

BackupEnginesListNextResponse: BackupEngineBaseResourceList & object

Contains response data for the listNext operation.

BackupEnginesListResponse

BackupEnginesListResponse: BackupEngineBaseResourceList & object

Contains response data for the list operation.

BackupItemType

BackupItemType: "Invalid" | "VM" | "FileFolder" | "AzureSqlDb" | "SQLDB" | "Exchange" | "Sharepoint" | "VMwareVM" | "SystemState" | "Client" | "GenericDataSource" | "SQLDataBase" | "AzureFileShare" | "SAPHanaDatabase"

Defines values for BackupItemType. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

readonly
enum

{string}

BackupJobsListNextResponse

BackupJobsListNextResponse: JobResourceList & object

Contains response data for the listNext operation.

BackupJobsListResponse

BackupJobsListResponse: JobResourceList & object

Contains response data for the list operation.

BackupManagementType

BackupManagementType: "Invalid" | "AzureIaasVM" | "MAB" | "DPM" | "AzureBackupServer" | "AzureSql" | "AzureStorage" | "AzureWorkload" | "DefaultBackup"

Defines values for BackupManagementType. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

readonly
enum

{string}

BackupOperationStatusesGetResponse

BackupOperationStatusesGetResponse: OperationStatus & object

Contains response data for the get operation.

BackupPoliciesListNextResponse

BackupPoliciesListNextResponse: ProtectionPolicyResourceList & object

Contains response data for the listNext operation.

BackupPoliciesListResponse

BackupPoliciesListResponse: ProtectionPolicyResourceList & object

Contains response data for the list operation.

BackupProtectableItemsListNextResponse

BackupProtectableItemsListNextResponse: WorkloadProtectableItemResourceList & object

Contains response data for the listNext operation.

BackupProtectableItemsListResponse

BackupProtectableItemsListResponse: WorkloadProtectableItemResourceList & object

Contains response data for the list operation.

BackupProtectedItemsListNextResponse

BackupProtectedItemsListNextResponse: ProtectedItemResourceList & object

Contains response data for the listNext operation.

BackupProtectedItemsListResponse

BackupProtectedItemsListResponse: ProtectedItemResourceList & object

Contains response data for the list operation.

BackupProtectionContainersListNextResponse

BackupProtectionContainersListNextResponse: ProtectionContainerResourceList & object

Contains response data for the listNext operation.

BackupProtectionContainersListResponse

BackupProtectionContainersListResponse: ProtectionContainerResourceList & object

Contains response data for the list operation.

BackupProtectionIntentListNextResponse

BackupProtectionIntentListNextResponse: ProtectionIntentResourceList & object

Contains response data for the listNext operation.

BackupProtectionIntentListResponse

BackupProtectionIntentListResponse: ProtectionIntentResourceList & object

Contains response data for the list operation.

BackupRequestUnion

BackupRequestUnion: BackupRequest | AzureFileShareBackupRequest | AzureWorkloadBackupRequest | IaasVMBackupRequest

Contains the possible cases for BackupRequest.

BackupResourceStorageConfigsGetResponse

BackupResourceStorageConfigsGetResponse: BackupResourceConfigResource & object

Contains response data for the get operation.

BackupResourceVaultConfigsGetResponse

BackupResourceVaultConfigsGetResponse: BackupResourceVaultConfigResource & object

Contains response data for the get operation.

BackupResourceVaultConfigsUpdateResponse

BackupResourceVaultConfigsUpdateResponse: BackupResourceVaultConfigResource & object

Contains response data for the update operation.

BackupStatusGetResponse

BackupStatusGetResponse: BackupStatusResponse & object

Contains response data for the get operation.

BackupType

BackupType: "Invalid" | "Full" | "Differential" | "Log" | "CopyOnlyFull"

Defines values for BackupType. Possible values include: 'Invalid', 'Full', 'Differential', 'Log', 'CopyOnlyFull'

readonly
enum

{string}

BackupUsageSummariesListResponse

BackupUsageSummariesListResponse: BackupManagementUsageList & object

Contains response data for the list operation.

BackupWorkloadItemsListNextResponse

BackupWorkloadItemsListNextResponse: WorkloadItemResourceList & object

Contains response data for the listNext operation.

BackupWorkloadItemsListResponse

BackupWorkloadItemsListResponse: WorkloadItemResourceList & object

Contains response data for the list operation.

ContainerType

ContainerType: "Invalid" | "Unknown" | "IaasVMContainer" | "IaasVMServiceContainer" | "DPMContainer" | "AzureBackupServerContainer" | "MABContainer" | "Cluster" | "AzureSqlContainer" | "Windows" | "VCenter" | "VMAppContainer" | "SQLAGWorkLoadContainer" | "StorageContainer" | "GenericContainer"

Defines values for ContainerType. Possible values include: 'Invalid', 'Unknown', 'IaasVMContainer', 'IaasVMServiceContainer', 'DPMContainer', 'AzureBackupServerContainer', 'MABContainer', 'Cluster', 'AzureSqlContainer', 'Windows', 'VCenter', 'VMAppContainer', 'SQLAGWorkLoadContainer', 'StorageContainer', 'GenericContainer'

readonly
enum

{string}

CopyOptions

CopyOptions: "Invalid" | "CreateCopy" | "Skip" | "Overwrite" | "FailOnConflict"

Defines values for CopyOptions. Possible values include: 'Invalid', 'CreateCopy', 'Skip', 'Overwrite', 'FailOnConflict'

readonly
enum

{string}

CreateMode

CreateMode: "Invalid" | "Default" | "Recover"

Defines values for CreateMode. Possible values include: 'Invalid', 'Default', 'Recover'

readonly
enum

{string}

DataSourceType

DataSourceType: "Invalid" | "VM" | "FileFolder" | "AzureSqlDb" | "SQLDB" | "Exchange" | "Sharepoint" | "VMwareVM" | "SystemState" | "Client" | "GenericDataSource" | "SQLDataBase" | "AzureFileShare" | "SAPHanaDatabase"

Defines values for DataSourceType. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

readonly
enum

{string}

DayOfWeek

DayOfWeek: "Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday"

Defines values for DayOfWeek. Possible values include: 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'

readonly
enum

{string}

EnhancedSecurityState

EnhancedSecurityState: "Invalid" | "Enabled" | "Disabled"

Defines values for EnhancedSecurityState. Possible values include: 'Invalid', 'Enabled', 'Disabled'

readonly
enum

{string}

ExportJobsOperationResultsGetResponse

ExportJobsOperationResultsGetResponse: OperationResultInfoBaseResource & object

Contains response data for the get operation.

FabricName

FabricName: "Invalid" | "Azure"

Defines values for FabricName. Possible values include: 'Invalid', 'Azure'

readonly
enum

{string}

FeatureSupportRequestUnion

FeatureSupportRequestUnion: FeatureSupportRequest | AzureBackupGoalFeatureSupportRequest | AzureVMResourceFeatureSupportRequest

Contains the possible cases for FeatureSupportRequest.

FeatureSupportValidateResponse

FeatureSupportValidateResponse: AzureVMResourceFeatureSupportResponse & object

Contains response data for the validate operation.

HealthState

HealthState: "Passed" | "ActionRequired" | "ActionSuggested" | "Invalid"

Defines values for HealthState. Possible values include: 'Passed', 'ActionRequired', 'ActionSuggested', 'Invalid'

readonly
enum

{string}

HealthStatus

HealthStatus: "Passed" | "ActionRequired" | "ActionSuggested" | "Invalid"

Defines values for HealthStatus. Possible values include: 'Passed', 'ActionRequired', 'ActionSuggested', 'Invalid'

readonly
enum

{string}

HttpStatusCode

HttpStatusCode: "Continue" | "SwitchingProtocols" | "OK" | "Created" | "Accepted" | "NonAuthoritativeInformation" | "NoContent" | "ResetContent" | "PartialContent" | "MultipleChoices" | "Ambiguous" | "MovedPermanently" | "Moved" | "Found" | "Redirect" | "SeeOther" | "RedirectMethod" | "NotModified" | "UseProxy" | "Unused" | "TemporaryRedirect" | "RedirectKeepVerb" | "BadRequest" | "Unauthorized" | "PaymentRequired" | "Forbidden" | "NotFound" | "MethodNotAllowed" | "NotAcceptable" | "ProxyAuthenticationRequired" | "RequestTimeout" | "Conflict" | "Gone" | "LengthRequired" | "PreconditionFailed" | "RequestEntityTooLarge" | "RequestUriTooLong" | "UnsupportedMediaType" | "RequestedRangeNotSatisfiable" | "ExpectationFailed" | "UpgradeRequired" | "InternalServerError" | "NotImplemented" | "BadGateway" | "ServiceUnavailable" | "GatewayTimeout" | "HttpVersionNotSupported"

Defines values for HttpStatusCode. Possible values include: 'Continue', 'SwitchingProtocols', 'OK', 'Created', 'Accepted', 'NonAuthoritativeInformation', 'NoContent', 'ResetContent', 'PartialContent', 'MultipleChoices', 'Ambiguous', 'MovedPermanently', 'Moved', 'Found', 'Redirect', 'SeeOther', 'RedirectMethod', 'NotModified', 'UseProxy', 'Unused', 'TemporaryRedirect', 'RedirectKeepVerb', 'BadRequest', 'Unauthorized', 'PaymentRequired', 'Forbidden', 'NotFound', 'MethodNotAllowed', 'NotAcceptable', 'ProxyAuthenticationRequired', 'RequestTimeout', 'Conflict', 'Gone', 'LengthRequired', 'PreconditionFailed', 'RequestEntityTooLarge', 'RequestUriTooLong', 'UnsupportedMediaType', 'RequestedRangeNotSatisfiable', 'ExpectationFailed', 'UpgradeRequired', 'InternalServerError', 'NotImplemented', 'BadGateway', 'ServiceUnavailable', 'GatewayTimeout', 'HttpVersionNotSupported'

readonly
enum

{string}

ILRRequestUnion

ILRRequestUnion: ILRRequest | IaasVMILRRegistrationRequest

Contains the possible cases for ILRRequest.

IaaSVMContainerUnion

IaaSVMContainerUnion: IaaSVMContainer | AzureIaaSClassicComputeVMContainer | AzureIaaSComputeVMContainer

Contains the possible cases for IaaSVMContainer.

IaaSVMProtectableItemUnion

IaaSVMProtectableItemUnion: IaaSVMProtectableItem | AzureIaaSClassicComputeVMProtectableItem | AzureIaaSComputeVMProtectableItem

Contains the possible cases for IaaSVMProtectableItem.

InquiryStatus

InquiryStatus: "Invalid" | "Success" | "Failed"

Defines values for InquiryStatus. Possible values include: 'Invalid', 'Success', 'Failed'

readonly
enum

{string}

IntentItemType

IntentItemType: "Invalid" | "SQLInstance" | "SQLAvailabilityGroupContainer"

Defines values for IntentItemType. Possible values include: 'Invalid', 'SQLInstance', 'SQLAvailabilityGroupContainer'

readonly
enum

{string}

JobDetailsGetResponse

JobDetailsGetResponse: JobResource & object

Contains response data for the get operation.

JobOperationType

JobOperationType: "Invalid" | "Register" | "UnRegister" | "ConfigureBackup" | "Backup" | "Restore" | "DisableBackup" | "DeleteBackupData"

Defines values for JobOperationType. Possible values include: 'Invalid', 'Register', 'UnRegister', 'ConfigureBackup', 'Backup', 'Restore', 'DisableBackup', 'DeleteBackupData'

readonly
enum

{string}

JobStatus

JobStatus: "Invalid" | "InProgress" | "Completed" | "Failed" | "CompletedWithWarnings" | "Cancelled" | "Cancelling"

Defines values for JobStatus. Possible values include: 'Invalid', 'InProgress', 'Completed', 'Failed', 'CompletedWithWarnings', 'Cancelled', 'Cancelling'

readonly
enum

{string}

JobSupportedAction

JobSupportedAction: "Invalid" | "Cancellable" | "Retriable"

Defines values for JobSupportedAction. Possible values include: 'Invalid', 'Cancellable', 'Retriable'

readonly
enum

{string}

JobUnion

JobUnion: Job | AzureIaaSVMJob | AzureStorageJob | AzureWorkloadJob | DpmJob | MabJob

Contains the possible cases for Job.

LastBackupStatus

LastBackupStatus: "Invalid" | "Healthy" | "Unhealthy" | "IRPending"

Defines values for LastBackupStatus. Possible values include: 'Invalid', 'Healthy', 'Unhealthy', 'IRPending'

readonly
enum

{string}

MabServerType

MabServerType: "Invalid" | "Unknown" | "IaasVMContainer" | "IaasVMServiceContainer" | "DPMContainer" | "AzureBackupServerContainer" | "MABContainer" | "Cluster" | "AzureSqlContainer" | "Windows" | "VCenter" | "VMAppContainer" | "SQLAGWorkLoadContainer" | "StorageContainer" | "GenericContainer"

Defines values for MabServerType. Possible values include: 'Invalid', 'Unknown', 'IaasVMContainer', 'IaasVMServiceContainer', 'DPMContainer', 'AzureBackupServerContainer', 'MABContainer', 'Cluster', 'AzureSqlContainer', 'Windows', 'VCenter', 'VMAppContainer', 'SQLAGWorkLoadContainer', 'StorageContainer', 'GenericContainer'

readonly
enum

{string}

MonthOfYear

MonthOfYear: "Invalid" | "January" | "February" | "March" | "April" | "May" | "June" | "July" | "August" | "September" | "October" | "November" | "December"

Defines values for MonthOfYear. Possible values include: 'Invalid', 'January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'

readonly
enum

{string}

OperationResultInfoBaseUnion

OperationResultInfoBaseUnion: OperationResultInfoBase | ExportJobsOperationResultInfo | OperationResultInfo

Contains the possible cases for OperationResultInfoBase.

OperationStatusExtendedInfoUnion

OperationStatusExtendedInfoUnion: OperationStatusExtendedInfo | OperationStatusJobExtendedInfo | OperationStatusJobsExtendedInfo | OperationStatusProvisionILRExtendedInfo

Contains the possible cases for OperationStatusExtendedInfo.

OperationStatusValues

OperationStatusValues: "Invalid" | "InProgress" | "Succeeded" | "Failed" | "Canceled"

Defines values for OperationStatusValues. Possible values include: 'Invalid', 'InProgress', 'Succeeded', 'Failed', 'Canceled'

readonly
enum

{string}

OperationValidateResponse

OperationValidateResponse: ValidateOperationsResponse & object

Contains response data for the validate operation.

OperationsListNextResponse

OperationsListNextResponse: ClientDiscoveryResponse & object

Contains response data for the listNext operation.

OperationsListResponse

OperationsListResponse: ClientDiscoveryResponse & object

Contains response data for the list operation.

OverwriteOptions

OverwriteOptions: "Invalid" | "FailOnConflict" | "Overwrite"

Defines values for OverwriteOptions. Possible values include: 'Invalid', 'FailOnConflict', 'Overwrite'

readonly
enum

{string}

PolicyType

PolicyType: "Invalid" | "Full" | "Differential" | "Log" | "CopyOnlyFull"

Defines values for PolicyType. Possible values include: 'Invalid', 'Full', 'Differential', 'Log', 'CopyOnlyFull'

readonly
enum

{string}

ProtectableContainerUnion

ProtectableContainerUnion: ProtectableContainer | AzureStorageProtectableContainer | AzureVMAppContainerProtectableContainer

Contains the possible cases for ProtectableContainer.

ProtectableContainersListNextResponse

ProtectableContainersListNextResponse: ProtectableContainerResourceList & object

Contains response data for the listNext operation.

ProtectableContainersListResponse

ProtectableContainersListResponse: ProtectableContainerResourceList & object

Contains response data for the list operation.

ProtectedItemHealthStatus

ProtectedItemHealthStatus: "Invalid" | "Healthy" | "Unhealthy" | "NotReachable" | "IRPending"

Defines values for ProtectedItemHealthStatus. Possible values include: 'Invalid', 'Healthy', 'Unhealthy', 'NotReachable', 'IRPending'

readonly
enum

{string}

ProtectedItemOperationResultsGetResponse

ProtectedItemOperationResultsGetResponse: ProtectedItemResource & object

Contains response data for the get operation.

ProtectedItemOperationStatusesGetResponse

ProtectedItemOperationStatusesGetResponse: OperationStatus & object

Contains response data for the get operation.

ProtectedItemState

ProtectedItemState: "Invalid" | "IRPending" | "Protected" | "ProtectionError" | "ProtectionStopped" | "ProtectionPaused"

Defines values for ProtectedItemState. Possible values include: 'Invalid', 'IRPending', 'Protected', 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'

readonly
enum

{string}

ProtectedItemUnion

ProtectedItemUnion: ProtectedItem | AzureFileshareProtectedItem | AzureIaaSVMProtectedItemUnion | AzureSqlProtectedItem | AzureVmWorkloadProtectedItemUnion | AzureVmWorkloadSQLDatabaseProtectedItem | DPMProtectedItem | GenericProtectedItem | MabFileFolderProtectedItem

Contains the possible cases for ProtectedItem.

ProtectedItemsCreateOrUpdateResponse

ProtectedItemsCreateOrUpdateResponse: ProtectedItemResource & object

Contains response data for the createOrUpdate operation.

ProtectedItemsGetResponse

ProtectedItemsGetResponse: ProtectedItemResource & object

Contains response data for the get operation.

ProtectionContainerOperationResultsGetResponse

ProtectionContainerOperationResultsGetResponse: ProtectionContainerResource & object

Contains response data for the get operation.

ProtectionContainerUnion

ProtectionContainerUnion: ProtectionContainer | AzureBackupServerContainer | AzureSqlContainer | AzureStorageContainer | AzureWorkloadContainerUnion | DpmContainer | GenericContainer | IaaSVMContainerUnion | MabContainer

Contains the possible cases for ProtectionContainer.

ProtectionContainersGetResponse

ProtectionContainersGetResponse: ProtectionContainerResource & object

Contains response data for the get operation.

ProtectionContainersRegisterResponse

ProtectionContainersRegisterResponse: ProtectionContainerResource & object

Contains response data for the register operation.

ProtectionIntentCreateOrUpdateResponse

ProtectionIntentCreateOrUpdateResponse: ProtectionIntentResource & object

Contains response data for the createOrUpdate operation.

ProtectionIntentGetResponse

ProtectionIntentGetResponse: ProtectionIntentResource & object

Contains response data for the get operation.

ProtectionIntentUnion

ProtectionIntentUnion: ProtectionIntent | AzureRecoveryServiceVaultProtectionIntentUnion | AzureResourceProtectionIntent

Contains the possible cases for ProtectionIntent.

ProtectionIntentValidateResponse

ProtectionIntentValidateResponse: PreValidateEnableBackupResponse & object

Contains response data for the validate operation.

ProtectionPoliciesCreateOrUpdateResponse

ProtectionPoliciesCreateOrUpdateResponse: ProtectionPolicyResource & object

Contains response data for the createOrUpdate operation.

ProtectionPoliciesGetResponse

ProtectionPoliciesGetResponse: ProtectionPolicyResource & object

Contains response data for the get operation.

ProtectionPolicyOperationResultsGetResponse

ProtectionPolicyOperationResultsGetResponse: ProtectionPolicyResource & object

Contains response data for the get operation.

ProtectionPolicyOperationStatusesGetResponse

ProtectionPolicyOperationStatusesGetResponse: OperationStatus & object

Contains response data for the get operation.

ProtectionPolicyUnion

ProtectionPolicyUnion: ProtectionPolicy | AzureFileShareProtectionPolicy | AzureIaaSVMProtectionPolicy | AzureSqlProtectionPolicy | AzureVmWorkloadProtectionPolicy | GenericProtectionPolicy | MabProtectionPolicy

Contains the possible cases for ProtectionPolicy.

ProtectionState

ProtectionState: "Invalid" | "IRPending" | "Protected" | "ProtectionError" | "ProtectionStopped" | "ProtectionPaused"

Defines values for ProtectionState. Possible values include: 'Invalid', 'IRPending', 'Protected', 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'

readonly
enum

{string}

ProtectionStatus

ProtectionStatus: "Invalid" | "NotProtected" | "Protecting" | "Protected" | "ProtectionFailed"

Defines values for ProtectionStatus. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

readonly
enum

{string}

RecoveryPointTierStatus

RecoveryPointTierStatus: "Invalid" | "Valid" | "Disabled" | "Deleted"

Defines values for RecoveryPointTierStatus. Possible values include: 'Invalid', 'Valid', 'Disabled', 'Deleted'

readonly
enum

{string}

RecoveryPointTierType

RecoveryPointTierType: "Invalid" | "InstantRP" | "HardenedRP"

Defines values for RecoveryPointTierType. Possible values include: 'Invalid', 'InstantRP', 'HardenedRP'

readonly
enum

{string}

RecoveryPointUnion

RecoveryPointUnion: RecoveryPoint | AzureFileShareRecoveryPoint | AzureWorkloadRecoveryPointUnion | AzureWorkloadSAPHanaRecoveryPointUnion | GenericRecoveryPoint | IaasVMRecoveryPoint

Contains the possible cases for RecoveryPoint.

RecoveryPointsGetResponse

RecoveryPointsGetResponse: RecoveryPointResource & object

Contains response data for the get operation.

RecoveryPointsListNextResponse

RecoveryPointsListNextResponse: RecoveryPointResourceList & object

Contains response data for the listNext operation.

RecoveryPointsListResponse

RecoveryPointsListResponse: RecoveryPointResourceList & object

Contains response data for the list operation.

RecoveryType

RecoveryType: "Invalid" | "OriginalLocation" | "AlternateLocation" | "RestoreDisks"

Defines values for RecoveryType. Possible values include: 'Invalid', 'OriginalLocation', 'AlternateLocation', 'RestoreDisks'

readonly
enum

{string}

RestorePointQueryType

RestorePointQueryType: "Invalid" | "Full" | "Log" | "Differential" | "FullAndDifferential" | "All"

Defines values for RestorePointQueryType. Possible values include: 'Invalid', 'Full', 'Log', 'Differential', 'FullAndDifferential', 'All'

readonly
enum

{string}

RestorePointType

RestorePointType: "Invalid" | "Full" | "Log" | "Differential"

Defines values for RestorePointType. Possible values include: 'Invalid', 'Full', 'Log', 'Differential'

readonly
enum

{string}

RestoreRequestType

RestoreRequestType: "Invalid" | "FullShareRestore" | "ItemLevelRestore"

Defines values for RestoreRequestType. Possible values include: 'Invalid', 'FullShareRestore', 'ItemLevelRestore'

readonly
enum

{string}

RestoreRequestUnion

RestoreRequestUnion: RestoreRequest | AzureFileShareRestoreRequest | AzureWorkloadRestoreRequestUnion | AzureWorkloadSAPHanaRestoreRequestUnion | IaasVMRestoreRequest

Contains the possible cases for RestoreRequest.

RetentionDurationType

RetentionDurationType: "Invalid" | "Days" | "Weeks" | "Months" | "Years"

Defines values for RetentionDurationType. Possible values include: 'Invalid', 'Days', 'Weeks', 'Months', 'Years'

readonly
enum

{string}

RetentionPolicyUnion

RetentionPolicyUnion: RetentionPolicy | LongTermRetentionPolicy | SimpleRetentionPolicy

Contains the possible cases for RetentionPolicy.

RetentionScheduleFormat

RetentionScheduleFormat: "Invalid" | "Daily" | "Weekly"

Defines values for RetentionScheduleFormat. Possible values include: 'Invalid', 'Daily', 'Weekly'

readonly
enum

{string}

SQLDataDirectoryType

SQLDataDirectoryType: "Invalid" | "Data" | "Log"

Defines values for SQLDataDirectoryType. Possible values include: 'Invalid', 'Data', 'Log'

readonly
enum

{string}

SchedulePolicyUnion

SchedulePolicyUnion: SchedulePolicy | LogSchedulePolicy | LongTermSchedulePolicy | SimpleSchedulePolicy

Contains the possible cases for SchedulePolicy.

ScheduleRunType

ScheduleRunType: "Invalid" | "Daily" | "Weekly"

Defines values for ScheduleRunType. Possible values include: 'Invalid', 'Daily', 'Weekly'

readonly
enum

{string}

SecurityPINsGetResponse

SecurityPINsGetResponse: TokenInformation & object

Contains response data for the get operation.

StorageType

StorageType: "Invalid" | "GeoRedundant" | "LocallyRedundant"

Defines values for StorageType. Possible values include: 'Invalid', 'GeoRedundant', 'LocallyRedundant'

readonly
enum

{string}

StorageTypeState

StorageTypeState: "Invalid" | "Locked" | "Unlocked"

Defines values for StorageTypeState. Possible values include: 'Invalid', 'Locked', 'Unlocked'

readonly
enum

{string}

SupportStatus

SupportStatus: "Invalid" | "Supported" | "DefaultOFF" | "DefaultON" | "NotSupported"

Defines values for SupportStatus. Possible values include: 'Invalid', 'Supported', 'DefaultOFF', 'DefaultON', 'NotSupported'

readonly
enum

{string}

Type

Type: "Invalid" | "BackupProtectedItemCountSummary" | "BackupProtectionContainerCountSummary"

Defines values for Type. Possible values include: 'Invalid', 'BackupProtectedItemCountSummary', 'BackupProtectionContainerCountSummary'

readonly
enum

{string}

UsagesUnit

UsagesUnit: "Count" | "Bytes" | "Seconds" | "Percent" | "CountPerSecond" | "BytesPerSecond"

Defines values for UsagesUnit. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', 'CountPerSecond', 'BytesPerSecond'

readonly
enum

{string}

ValidateOperationRequestUnion

ValidateOperationRequestUnion: ValidateOperationRequest | ValidateRestoreOperationRequestUnion

Contains the possible cases for ValidateOperationRequest.

ValidateRestoreOperationRequestUnion

ValidateRestoreOperationRequestUnion: ValidateRestoreOperationRequest | ValidateIaasVMRestoreOperationRequest

Contains the possible cases for ValidateRestoreOperationRequest.

ValidationStatus

ValidationStatus: "Invalid" | "Succeeded" | "Failed"

Defines values for ValidationStatus. Possible values include: 'Invalid', 'Succeeded', 'Failed'

readonly
enum

{string}

WeekOfMonth

WeekOfMonth: "First" | "Second" | "Third" | "Fourth" | "Last" | "Invalid"

Defines values for WeekOfMonth. Possible values include: 'First', 'Second', 'Third', 'Fourth', 'Last', 'Invalid'

readonly
enum

{string}

WorkloadItemType

WorkloadItemType: "Invalid" | "SQLInstance" | "SQLDataBase" | "SAPHanaSystem" | "SAPHanaDatabase"

Defines values for WorkloadItemType. Possible values include: 'Invalid', 'SQLInstance', 'SQLDataBase', 'SAPHanaSystem', 'SAPHanaDatabase'

readonly
enum

{string}

WorkloadItemUnion

WorkloadItemUnion: WorkloadItem | AzureVmWorkloadItemUnion

Contains the possible cases for WorkloadItem.

WorkloadProtectableItemUnion

WorkloadProtectableItemUnion: WorkloadProtectableItem | AzureFileShareProtectableItem | AzureVmWorkloadProtectableItemUnion | IaaSVMProtectableItemUnion

Contains the possible cases for WorkloadProtectableItem.

WorkloadType

WorkloadType: "Invalid" | "VM" | "FileFolder" | "AzureSqlDb" | "SQLDB" | "Exchange" | "Sharepoint" | "VMwareVM" | "SystemState" | "Client" | "GenericDataSource" | "SQLDataBase" | "AzureFileShare" | "SAPHanaDatabase"

Defines values for WorkloadType. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

readonly
enum

{string}

Variables

Const BaseResource

BaseResource: CompositeMapper = BaseResourceMapper

Const CloudError

CloudError: CompositeMapper = CloudErrorMapper

Object literals

Const AzureBackupGoalFeatureSupportRequest

AzureBackupGoalFeatureSupportRequest: object
interface

An interface representing AzureBackupGoalFeatureSupportRequest. Azure backup goal feature specific request.

featureType

featureType: "AzureBackupGoals"
member

{string} featureType Polymorphic Discriminator

serializedName

serializedName: string = "AzureBackupGoals"

type

type: object

className

className: string = "AzureBackupGoalFeatureSupportRequest"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FeatureSupportRequest.type.polymorphicDiscriminator

uberParent

uberParent: string = "FeatureSupportRequest"

modelProperties

modelProperties: object

Const AzureBackupServerContainer

AzureBackupServerContainer: object
interface

An interface representing AzureBackupServerContainer. AzureBackupServer (DPMVenus) workload-specific protection container.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional canReRegister

canReRegister: undefined | false | true
member

{boolean} [canReRegister] Specifies whether the container is re-registrable.

Optional containerId

containerId: undefined | string
member

{string} [containerId] ID of container.

containerType

containerType: "AzureBackupServerContainer"
member

{string} containerType Polymorphic Discriminator

Optional dpmAgentVersion

dpmAgentVersion: undefined | string
member

{string} [dpmAgentVersion] Backup engine Agent version

Optional dpmServers

dpmServers: string[]
member

{string[]} [dpmServers] List of BackupEngines protecting the container

Optional extendedInfo

extendedInfo: DPMContainerExtendedInfo
member

{DPMContainerExtendedInfo} [extendedInfo] Extended Info of the container.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the container.

Optional healthStatus

healthStatus: undefined | string
member

{string} [healthStatus] Status of health of the container.

Optional protectedItemCount

protectedItemCount: undefined | number
member

{number} [protectedItemCount] Number of protected items in the BackupEngine

Optional protectionStatus

protectionStatus: undefined | string
member

{string} [protectionStatus] Protection status of the container.

Optional registrationStatus

registrationStatus: undefined | string
member

{string} [registrationStatus] Status of registration of the container with the Recovery Services Vault.

serializedName

serializedName: string = "AzureBackupServerContainer"

Optional upgradeAvailable

upgradeAvailable: undefined | false | true
member

{boolean} [upgradeAvailable] To check if upgrade available

type

type: object

className

className: string = "AzureBackupServerContainer"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionContainer.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionContainer"

modelProperties

modelProperties: object

canReRegister

canReRegister: object

serializedName

serializedName: string = "canReRegister"

type

type: object

name

name: "Boolean" = "Boolean"

containerId

containerId: object

serializedName

serializedName: string = "containerId"

type

type: object

name

name: "String" = "String"

dpmAgentVersion

dpmAgentVersion: object

serializedName

serializedName: string = "dpmAgentVersion"

type

type: object

name

name: "String" = "String"

dpmServers

dpmServers: object

serializedName

serializedName: string = "dpmServers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

extendedInfo

extendedInfo: object

serializedName

serializedName: string = "extendedInfo"

type

type: object

className

className: string = "DPMContainerExtendedInfo"

name

name: "Composite" = "Composite"

protectedItemCount

protectedItemCount: object

serializedName

serializedName: string = "protectedItemCount"

type

type: object

name

name: "Number" = "Number"

protectionStatus

protectionStatus: object

serializedName

serializedName: string = "protectionStatus"

type

type: object

name

name: "String" = "String"

upgradeAvailable

upgradeAvailable: object

serializedName

serializedName: string = "upgradeAvailable"

type

type: object

name

name: "Boolean" = "Boolean"

Const AzureBackupServerEngine

AzureBackupServerEngine: object
interface

An interface representing AzureBackupServerEngine. Backup engine type when Azure Backup Server is used to manage the backups.

Optional azureBackupAgentVersion

azureBackupAgentVersion: undefined | string
member

{string} [azureBackupAgentVersion] Backup agent version

Optional backupEngineId

backupEngineId: undefined | string
member

{string} [backupEngineId] ID of the backup engine.

Optional backupEngineState

backupEngineState: undefined | string
member

{string} [backupEngineState] Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed}

backupEngineType

backupEngineType: "AzureBackupServerEngine"
member

{string} backupEngineType Polymorphic Discriminator

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup management for the backup engine. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional canReRegister

canReRegister: undefined | false | true
member

{boolean} [canReRegister] Flag indicating if the backup engine be registered, once already registered.

Optional dpmVersion

dpmVersion: undefined | string
member

{string} [dpmVersion] Backup engine version

Optional extendedInfo

extendedInfo: BackupEngineExtendedInfo
member

{BackupEngineExtendedInfo} [extendedInfo] Extended info of the backupengine

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the backup engine.

Optional healthStatus

healthStatus: undefined | string
member

{string} [healthStatus] Backup status of the backup engine.

Optional isAzureBackupAgentUpgradeAvailable

isAzureBackupAgentUpgradeAvailable: undefined | false | true
member

{boolean} [isAzureBackupAgentUpgradeAvailable] To check if backup agent upgrade available

Optional isDpmUpgradeAvailable

isDpmUpgradeAvailable: undefined | false | true
member

{boolean} [isDpmUpgradeAvailable] To check if backup engine upgrade available

Optional registrationStatus

registrationStatus: undefined | string
member

{string} [registrationStatus] Registration status of the backup engine with the Recovery Services Vault.

serializedName

serializedName: string = "AzureBackupServerEngine"

type

type: object

className

className: string = "AzureBackupServerEngine"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = BackupEngineBase.type.polymorphicDiscriminator

uberParent

uberParent: string = "BackupEngineBase"

modelProperties

modelProperties: object

Const AzureFileShareBackupRequest

AzureFileShareBackupRequest: object
interface

An interface representing AzureFileShareBackupRequest. AzureFileShare workload-specific backup request.

objectType

objectType: "AzureFileShareBackupRequest"
member

{string} objectType Polymorphic Discriminator

Optional recoveryPointExpiryTimeInUTC

recoveryPointExpiryTimeInUTC: Date
member

{Date} [recoveryPointExpiryTimeInUTC] Backup copy will expire after the time specified (UTC).

serializedName

serializedName: string = "AzureFileShareBackupRequest"

type

type: object

className

className: string = "AzureFileShareBackupRequest"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = BackupRequest.type.polymorphicDiscriminator

uberParent

uberParent: string = "BackupRequest"

modelProperties

modelProperties: object

recoveryPointExpiryTimeInUTC

recoveryPointExpiryTimeInUTC: object

serializedName

serializedName: string = "recoveryPointExpiryTimeInUTC"

type

type: object

name

name: "DateTime" = "DateTime"

Const AzureFileShareProtectableItem

AzureFileShareProtectableItem: object
interface

An interface representing AzureFileShareProtectableItem. Protectable item for Azure Fileshare workloads.

Optional azureFileShareType

azureFileShareType: AzureFileShareType
member

{AzureFileShareType} [azureFileShareType] File Share type XSync or XSMB. Possible values include: 'Invalid', 'XSMB', 'XSync'

Optional backupManagementType

backupManagementType: undefined | string
member

{string} [backupManagementType] Type of backup managemenent to backup an item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the backup item.

Optional parentContainerFabricId

parentContainerFabricId: undefined | string
member

{string} [parentContainerFabricId] Full Fabric ID of container to which this protectable item belongs. For example, ARM ID.

Optional parentContainerFriendlyName

parentContainerFriendlyName: undefined | string
member

{string} [parentContainerFriendlyName] Friendly name of container to which this protectable item belongs.

protectableItemType

protectableItemType: "AzureFileShare"
member

{string} protectableItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionStatus
member

{ProtectionStatus} [protectionState] State of the back up item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "AzureFileShare"

Optional workloadType

workloadType: undefined | string
member

{string} [workloadType] Type of workload for the backup management

type

type: object

className

className: string = "AzureFileShareProtectableItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = WorkloadProtectableItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "WorkloadProtectableItem"

modelProperties

modelProperties: object

azureFileShareType

azureFileShareType: object

serializedName

serializedName: string = "azureFileShareType"

type

type: object

name

name: "String" = "String"

parentContainerFabricId

parentContainerFabricId: object

serializedName

serializedName: string = "parentContainerFabricId"

type

type: object

name

name: "String" = "String"

parentContainerFriendlyName

parentContainerFriendlyName: object

serializedName

serializedName: string = "parentContainerFriendlyName"

type

type: object

name

name: "String" = "String"

Const AzureFileShareProtectionPolicy

AzureFileShareProtectionPolicy: object
interface

An interface representing AzureFileShareProtectionPolicy. AzureStorage backup policy.

backupManagementType

backupManagementType: "AzureStorage"
member

{string} backupManagementType Polymorphic Discriminator

Optional protectedItemsCount

protectedItemsCount: undefined | number
member

{number} [protectedItemsCount] Number of items associated with this policy.

Optional retentionPolicy

retentionPolicy: RetentionPolicyUnion
member

{RetentionPolicyUnion} [retentionPolicy] Retention policy with the details on backup copy retention ranges.

Optional schedulePolicy

schedulePolicy: SchedulePolicyUnion
member

{SchedulePolicyUnion} [schedulePolicy] Backup schedule specified as part of backup policy.

serializedName

serializedName: string = "AzureStorage"

Optional timeZone

timeZone: undefined | string
member

{string} [timeZone] TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time".

Optional workLoadType

workLoadType: WorkloadType
member

{WorkloadType} [workLoadType] Type of workload for the backup management. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

type

type: object

className

className: string = "AzureFileShareProtectionPolicy"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionPolicy.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionPolicy"

modelProperties

modelProperties: object

retentionPolicy

retentionPolicy: object

serializedName

serializedName: string = "retentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

name: "Composite" = "Composite"

schedulePolicy

schedulePolicy: object

serializedName

serializedName: string = "schedulePolicy"

type

type: object

className

className: string = "SchedulePolicy"

name

name: "Composite" = "Composite"

timeZone

timeZone: object

serializedName

serializedName: string = "timeZone"

type

type: object

name

name: "String" = "String"

workLoadType

workLoadType: object

serializedName

serializedName: string = "workLoadType"

type

type: object

name

name: "String" = "String"

Const AzureFileShareRecoveryPoint

AzureFileShareRecoveryPoint: object
interface

An interface representing AzureFileShareRecoveryPoint. Azure File Share workload specific backup copy.

Optional fileShareSnapshotUri

fileShareSnapshotUri: undefined | string
member

{string} [fileShareSnapshotUri] Contains Url to the snapshot of fileshare, if applicable

objectType

objectType: "AzureFileShareRecoveryPoint"
member

{string} objectType Polymorphic Discriminator

Optional recoveryPointTime

recoveryPointTime: Date
member

{Date} [recoveryPointTime] Time at which this backup copy was created.

Optional recoveryPointType

recoveryPointType: undefined | string
member

{string} [recoveryPointType] Type of the backup copy. Specifies whether it is a crash consistent backup or app consistent.

serializedName

serializedName: string = "AzureFileShareRecoveryPoint"

type

type: object

className

className: string = "AzureFileShareRecoveryPoint"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RecoveryPoint.type.polymorphicDiscriminator

uberParent

uberParent: string = "RecoveryPoint"

modelProperties

modelProperties: object

fileShareSnapshotUri

fileShareSnapshotUri: object

serializedName

serializedName: string = "fileShareSnapshotUri"

type

type: object

name

name: "String" = "String"

recoveryPointTime

recoveryPointTime: object

serializedName

serializedName: string = "recoveryPointTime"

type

type: object

name

name: "DateTime" = "DateTime"

recoveryPointType

recoveryPointType: object

serializedName

serializedName: string = "recoveryPointType"

type

type: object

name

name: "String" = "String"

Const AzureFileShareRestoreRequest

AzureFileShareRestoreRequest: object
interface

An interface representing AzureFileShareRestoreRequest. AzureFileShare Restore Request

Optional copyOptions

copyOptions: CopyOptions
member

{CopyOptions} [copyOptions] Options to resolve copy conflicts. Possible values include: 'Invalid', 'CreateCopy', 'Skip', 'Overwrite', 'FailOnConflict'

objectType

objectType: "AzureFileShareRestoreRequest"
member

{string} objectType Polymorphic Discriminator

Optional recoveryType

recoveryType: RecoveryType
member

{RecoveryType} [recoveryType] Type of this recovery. Possible values include: 'Invalid', 'OriginalLocation', 'AlternateLocation', 'RestoreDisks'

Optional restoreFileSpecs

restoreFileSpecs: RestoreFileSpecs[]
member

{RestoreFileSpecs[]} [restoreFileSpecs] List of Source Files/Folders(which need to recover) and TargetFolderPath details

Optional restoreRequestType

restoreRequestType: RestoreRequestType
member

{RestoreRequestType} [restoreRequestType] Restore Type (FullShareRestore or ItemLevelRestore). Possible values include: 'Invalid', 'FullShareRestore', 'ItemLevelRestore'

serializedName

serializedName: string = "AzureFileShareRestoreRequest"

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] Source storage account ARM Id

Optional targetDetails

targetDetails: TargetAFSRestoreInfo
member

{TargetAFSRestoreInfo} [targetDetails] Target File Share Details

type

type: object

className

className: string = "AzureFileShareRestoreRequest"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RestoreRequest.type.polymorphicDiscriminator

uberParent

uberParent: string = "RestoreRequest"

modelProperties

modelProperties: object

copyOptions

copyOptions: object

serializedName

serializedName: string = "copyOptions"

type

type: object

name

name: "String" = "String"

recoveryType

recoveryType: object

serializedName

serializedName: string = "recoveryType"

type

type: object

name

name: "String" = "String"

restoreFileSpecs

restoreFileSpecs: object

serializedName

serializedName: string = "restoreFileSpecs"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RestoreFileSpecs"

name

name: "Composite" = "Composite"

restoreRequestType

restoreRequestType: object

serializedName

serializedName: string = "restoreRequestType"

type

type: object

name

name: "String" = "String"

sourceResourceId

sourceResourceId: object

serializedName

serializedName: string = "sourceResourceId"

type

type: object

name

name: "String" = "String"

targetDetails

targetDetails: object

serializedName

serializedName: string = "targetDetails"

type

type: object

className

className: string = "TargetAFSRestoreInfo"

name

name: "Composite" = "Composite"

Const AzureFileshareProtectedItem

AzureFileshareProtectedItem: object
interface

An interface representing AzureFileshareProtectedItem. Azure File Share workload-specific backup item.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional backupSetName

backupSetName: undefined | string
member

{string} [backupSetName] Name of the backup set the backup item belongs to

Optional containerName

containerName: undefined | string
member

{string} [containerName] Unique name of container

Optional createMode

createMode: CreateMode
member

{CreateMode} [createMode] Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: 'Invalid', 'Default', 'Recover'

Optional extendedInfo

extendedInfo: AzureFileshareProtectedItemExtendedInfo
member

{AzureFileshareProtectedItemExtendedInfo} [extendedInfo] Additional information with this backup item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the fileshare represented by this backup item.

Optional healthStatus

healthStatus: HealthStatus
member

{HealthStatus} [healthStatus] backups running status for this backup item. Possible values include: 'Passed', 'ActionRequired', 'ActionSuggested', 'Invalid'

Optional lastBackupStatus

lastBackupStatus: undefined | string
member

{string} [lastBackupStatus] Last backup operation status. Possible values: Healthy, Unhealthy.

Optional lastBackupTime

lastBackupTime: Date
member

{Date} [lastBackupTime] Timestamp of the last backup operation on this backup item.

Optional lastRecoveryPoint

lastRecoveryPoint: Date
member

{Date} [lastRecoveryPoint] Timestamp when the last (latest) backup copy was created for this backup item.

Optional policyId

policyId: undefined | string
member

{string} [policyId] ID of the backup policy with which this item is backed up.

protectedItemType

protectedItemType: "AzureFileShareProtectedItem"
member

{string} protectedItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionState
member

{ProtectionState} [protectionState] Backup state of this backup item. Possible values include: 'Invalid', 'IRPending', 'Protected', 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'

Optional protectionStatus

protectionStatus: undefined | string
member

{string} [protectionStatus] Backup status of this backup item.

serializedName

serializedName: string = "AzureFileShareProtectedItem"

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] ARM ID of the resource to be backed up.

Optional workloadType

workloadType: DataSourceType
member

{DataSourceType} [workloadType] Type of workload this item represents. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

type

type: object

className

className: string = "AzureFileshareProtectedItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectedItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectedItem"

modelProperties

modelProperties: object

extendedInfo

extendedInfo: object

serializedName

serializedName: string = "extendedInfo"

type

type: object

className

className: string = "AzureFileshareProtectedItemExtendedInfo"

name

name: "Composite" = "Composite"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

healthStatus

healthStatus: object

serializedName

serializedName: string = "healthStatus"

type

type: object

name

name: "String" = "String"

lastBackupStatus

lastBackupStatus: object

serializedName

serializedName: string = "lastBackupStatus"

type

type: object

name

name: "String" = "String"

lastBackupTime

lastBackupTime: object

serializedName

serializedName: string = "lastBackupTime"

type

type: object

name

name: "DateTime" = "DateTime"

protectionState

protectionState: object

serializedName

serializedName: string = "protectionState"

type

type: object

name

name: "String" = "String"

protectionStatus

protectionStatus: object

serializedName

serializedName: string = "protectionStatus"

type

type: object

name

name: "String" = "String"

Const AzureFileshareProtectedItemExtendedInfo

AzureFileshareProtectedItemExtendedInfo: object
interface

An interface representing AzureFileshareProtectedItemExtendedInfo. Additional information about Azure File Share backup item.

Optional oldestRecoveryPoint

oldestRecoveryPoint: Date
member

{Date} [oldestRecoveryPoint] The oldest backup copy available for this item in the service.

Optional policyState

policyState: undefined | string
member

{string} [policyState] Indicates consistency of policy object and policy applied to this backup item.

Optional recoveryPointCount

recoveryPointCount: undefined | number
member

{number} [recoveryPointCount] Number of available backup copies associated with this backup item.

serializedName

serializedName: string = "AzureFileshareProtectedItemExtendedInfo"

type

type: object

className

className: string = "AzureFileshareProtectedItemExtendedInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

oldestRecoveryPoint

oldestRecoveryPoint: object

serializedName

serializedName: string = "oldestRecoveryPoint"

type

type: object

name

name: "DateTime" = "DateTime"

policyState

policyState: object

serializedName

serializedName: string = "policyState"

type

type: object

name

name: "String" = "String"

recoveryPointCount

recoveryPointCount: object

serializedName

serializedName: string = "recoveryPointCount"

type

type: object

name

name: "Number" = "Number"

Const AzureIaaSClassicComputeVMContainer

AzureIaaSClassicComputeVMContainer: object
interface

An interface representing AzureIaaSClassicComputeVMContainer. IaaS VM workload-specific backup item representing a classic virtual machine.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

containerType

containerType: "Microsoft.ClassicCompute/virtualMachines"
member

{string} containerType Polymorphic Discriminator

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the container.

Optional healthStatus

healthStatus: undefined | string
member

{string} [healthStatus] Status of health of the container.

Optional registrationStatus

registrationStatus: undefined | string
member

{string} [registrationStatus] Status of registration of the container with the Recovery Services Vault.

Optional resourceGroup

resourceGroup: undefined | string
member

{string} [resourceGroup] Resource group name of Recovery Services Vault.

serializedName

serializedName: string = "Microsoft.ClassicCompute/virtualMachines"

Optional virtualMachineId

virtualMachineId: undefined | string
member

{string} [virtualMachineId] Fully qualified ARM url of the virtual machine represented by this Azure IaaS VM container.

Optional virtualMachineVersion

virtualMachineVersion: undefined | string
member

{string} [virtualMachineVersion] Specifies whether the container represents a Classic or an Azure Resource Manager VM.

type

type: object

className

className: string = "AzureIaaSClassicComputeVMContainer"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionContainer.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionContainer"

modelProperties

modelProperties: object

Const AzureIaaSClassicComputeVMProtectableItem

AzureIaaSClassicComputeVMProtectableItem: object
interface

An interface representing AzureIaaSClassicComputeVMProtectableItem. IaaS VM workload-specific backup item representing the Classic Compute VM.

Optional backupManagementType

backupManagementType: undefined | string
member

{string} [backupManagementType] Type of backup managemenent to backup an item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the backup item.

protectableItemType

protectableItemType: "Microsoft.ClassicCompute/virtualMachines"
member

{string} protectableItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionStatus
member

{ProtectionStatus} [protectionState] State of the back up item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "Microsoft.ClassicCompute/virtualMachines"

Optional virtualMachineId

virtualMachineId: undefined | string
member

{string} [virtualMachineId] Fully qualified ARM ID of the virtual machine.

Optional workloadType

workloadType: undefined | string
member

{string} [workloadType] Type of workload for the backup management

type

type: object

className

className: string = "AzureIaaSClassicComputeVMProtectableItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = WorkloadProtectableItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "WorkloadProtectableItem"

modelProperties

modelProperties: object

Const AzureIaaSClassicComputeVMProtectedItem

AzureIaaSClassicComputeVMProtectedItem: object
interface

An interface representing AzureIaaSClassicComputeVMProtectedItem. IaaS VM workload-specific backup item representing the Classic Compute VM.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional backupSetName

backupSetName: undefined | string
member

{string} [backupSetName] Name of the backup set the backup item belongs to

Optional containerName

containerName: undefined | string
member

{string} [containerName] Unique name of container

Optional createMode

createMode: CreateMode
member

{CreateMode} [createMode] Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: 'Invalid', 'Default', 'Recover'

Optional extendedInfo

extendedInfo: AzureIaaSVMProtectedItemExtendedInfo
member

{AzureIaaSVMProtectedItemExtendedInfo} [extendedInfo] Additional information for this backup item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the VM represented by this backup item.

Optional healthDetails

healthDetails: AzureIaaSVMHealthDetails[]
member

{AzureIaaSVMHealthDetails[]} [healthDetails] Health details on this backup item.

Optional healthStatus

healthStatus: HealthStatus
member

{HealthStatus} [healthStatus] Health status of protected item. Possible values include: 'Passed', 'ActionRequired', 'ActionSuggested', 'Invalid'

Optional lastBackupStatus

lastBackupStatus: undefined | string
member

{string} [lastBackupStatus] Last backup operation status.

Optional lastBackupTime

lastBackupTime: Date
member

{Date} [lastBackupTime] Timestamp of the last backup operation on this backup item.

Optional lastRecoveryPoint

lastRecoveryPoint: Date
member

{Date} [lastRecoveryPoint] Timestamp when the last (latest) backup copy was created for this backup item.

Optional policyId

policyId: undefined | string
member

{string} [policyId] ID of the backup policy with which this item is backed up.

Optional protectedItemDataId

protectedItemDataId: undefined | string
member

{string} [protectedItemDataId] Data ID of the protected item.

protectedItemType

protectedItemType: "Microsoft.ClassicCompute/virtualMachines"
member

{string} protectedItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionState
member

{ProtectionState} [protectionState] Backup state of this backup item. Possible values include: 'Invalid', 'IRPending', 'Protected', 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'

Optional protectionStatus

protectionStatus: undefined | string
member

{string} [protectionStatus] Backup status of this backup item.

serializedName

serializedName: string = "Microsoft.ClassicCompute/virtualMachines"

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] ARM ID of the resource to be backed up.

Optional virtualMachineId

virtualMachineId: undefined | string
member

{string} [virtualMachineId] Fully qualified ARM ID of the virtual machine represented by this item.

Optional workloadType

workloadType: DataSourceType
member

{DataSourceType} [workloadType] Type of workload this item represents. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

type

type: object

className

className: string = "AzureIaaSClassicComputeVMProtectedItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectedItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectedItem"

modelProperties

modelProperties: object

Const AzureIaaSComputeVMContainer

AzureIaaSComputeVMContainer: object
interface

An interface representing AzureIaaSComputeVMContainer. IaaS VM workload-specific backup item representing an Azure Resource Manager virtual machine.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

containerType

containerType: "Microsoft.Compute/virtualMachines"
member

{string} containerType Polymorphic Discriminator

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the container.

Optional healthStatus

healthStatus: undefined | string
member

{string} [healthStatus] Status of health of the container.

Optional registrationStatus

registrationStatus: undefined | string
member

{string} [registrationStatus] Status of registration of the container with the Recovery Services Vault.

Optional resourceGroup

resourceGroup: undefined | string
member

{string} [resourceGroup] Resource group name of Recovery Services Vault.

serializedName

serializedName: string = "Microsoft.Compute/virtualMachines"

Optional virtualMachineId

virtualMachineId: undefined | string
member

{string} [virtualMachineId] Fully qualified ARM url of the virtual machine represented by this Azure IaaS VM container.

Optional virtualMachineVersion

virtualMachineVersion: undefined | string
member

{string} [virtualMachineVersion] Specifies whether the container represents a Classic or an Azure Resource Manager VM.

type

type: object

className

className: string = "AzureIaaSComputeVMContainer"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionContainer.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionContainer"

modelProperties

modelProperties: object

Const AzureIaaSComputeVMProtectableItem

AzureIaaSComputeVMProtectableItem: object
interface

An interface representing AzureIaaSComputeVMProtectableItem. IaaS VM workload-specific backup item representing the Azure Resource Manager VM.

Optional backupManagementType

backupManagementType: undefined | string
member

{string} [backupManagementType] Type of backup managemenent to backup an item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the backup item.

protectableItemType

protectableItemType: "Microsoft.Compute/virtualMachines"
member

{string} protectableItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionStatus
member

{ProtectionStatus} [protectionState] State of the back up item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "Microsoft.Compute/virtualMachines"

Optional virtualMachineId

virtualMachineId: undefined | string
member

{string} [virtualMachineId] Fully qualified ARM ID of the virtual machine.

Optional workloadType

workloadType: undefined | string
member

{string} [workloadType] Type of workload for the backup management

type

type: object

className

className: string = "AzureIaaSComputeVMProtectableItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = WorkloadProtectableItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "WorkloadProtectableItem"

modelProperties

modelProperties: object

Const AzureIaaSComputeVMProtectedItem

AzureIaaSComputeVMProtectedItem: object
interface

An interface representing AzureIaaSComputeVMProtectedItem. IaaS VM workload-specific backup item representing the Azure Resource Manager VM.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional backupSetName

backupSetName: undefined | string
member

{string} [backupSetName] Name of the backup set the backup item belongs to

Optional containerName

containerName: undefined | string
member

{string} [containerName] Unique name of container

Optional createMode

createMode: CreateMode
member

{CreateMode} [createMode] Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: 'Invalid', 'Default', 'Recover'

Optional extendedInfo

extendedInfo: AzureIaaSVMProtectedItemExtendedInfo
member

{AzureIaaSVMProtectedItemExtendedInfo} [extendedInfo] Additional information for this backup item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the VM represented by this backup item.

Optional healthDetails

healthDetails: AzureIaaSVMHealthDetails[]
member

{AzureIaaSVMHealthDetails[]} [healthDetails] Health details on this backup item.

Optional healthStatus

healthStatus: HealthStatus
member

{HealthStatus} [healthStatus] Health status of protected item. Possible values include: 'Passed', 'ActionRequired', 'ActionSuggested', 'Invalid'

Optional lastBackupStatus

lastBackupStatus: undefined | string
member

{string} [lastBackupStatus] Last backup operation status.

Optional lastBackupTime

lastBackupTime: Date
member

{Date} [lastBackupTime] Timestamp of the last backup operation on this backup item.

Optional lastRecoveryPoint

lastRecoveryPoint: Date
member

{Date} [lastRecoveryPoint] Timestamp when the last (latest) backup copy was created for this backup item.

Optional policyId

policyId: undefined | string
member

{string} [policyId] ID of the backup policy with which this item is backed up.

Optional protectedItemDataId

protectedItemDataId: undefined | string
member

{string} [protectedItemDataId] Data ID of the protected item.

protectedItemType

protectedItemType: "Microsoft.Compute/virtualMachines"
member

{string} protectedItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionState
member

{ProtectionState} [protectionState] Backup state of this backup item. Possible values include: 'Invalid', 'IRPending', 'Protected', 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'

Optional protectionStatus

protectionStatus: undefined | string
member

{string} [protectionStatus] Backup status of this backup item.

serializedName

serializedName: string = "Microsoft.Compute/virtualMachines"

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] ARM ID of the resource to be backed up.

Optional virtualMachineId

virtualMachineId: undefined | string
member

{string} [virtualMachineId] Fully qualified ARM ID of the virtual machine represented by this item.

Optional workloadType

workloadType: DataSourceType
member

{DataSourceType} [workloadType] Type of workload this item represents. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

type

type: object

className

className: string = "AzureIaaSComputeVMProtectedItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectedItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectedItem"

modelProperties

modelProperties: object

Const AzureIaaSVMErrorInfo

AzureIaaSVMErrorInfo: object
interface

An interface representing AzureIaaSVMErrorInfo. Azure IaaS VM workload-specific error information.

Optional errorCode

errorCode: undefined | number
member

{number} [errorCode] Error code.

Optional errorString

errorString: undefined | string
member

{string} [errorString] Localized error string.

Optional errorTitle

errorTitle: undefined | string
member

{string} [errorTitle] Title: Typically, the entity that the error pertains to.

Optional recommendations

recommendations: string[]
member

{string[]} [recommendations] List of localized recommendations for above error code.

serializedName

serializedName: string = "AzureIaaSVMErrorInfo"

type

type: object

className

className: string = "AzureIaaSVMErrorInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "errorCode"

type

type: object

name

name: "Number" = "Number"

errorString

errorString: object

serializedName

serializedName: string = "errorString"

type

type: object

name

name: "String" = "String"

errorTitle

errorTitle: object

serializedName

serializedName: string = "errorTitle"

type

type: object

name

name: "String" = "String"

recommendations

recommendations: object

serializedName

serializedName: string = "recommendations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const AzureIaaSVMHealthDetails

AzureIaaSVMHealthDetails: object
interface

An interface representing AzureIaaSVMHealthDetails. Azure IaaS VM workload-specific Health Details.

Optional code

code: undefined | number
member

{number} [code] Health Code

Optional message

message: undefined | string
member

{string} [message] Health Message

Optional recommendations

recommendations: string[]
member

{string[]} [recommendations] Health Recommended Actions

serializedName

serializedName: string = "AzureIaaSVMHealthDetails"

Optional title

title: undefined | string
member

{string} [title] Health Title

type

type: object

className

className: string = "AzureIaaSVMHealthDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "Number" = "Number"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

recommendations

recommendations: object

serializedName

serializedName: string = "recommendations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

title

title: object

serializedName

serializedName: string = "title"

type

type: object

name

name: "String" = "String"

Const AzureIaaSVMJob

AzureIaaSVMJob: object
interface

An interface representing AzureIaaSVMJob. Azure IaaS VM workload-specifc job object.

Optional actionsInfo

actionsInfo: JobSupportedAction[]
member

{JobSupportedAction[]} [actionsInfo] Gets or sets the state/actions applicable on this job like cancel/retry.

Optional activityId

activityId: undefined | string
member

{string} [activityId] ActivityId of job.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Backup management type to execute the current job. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional duration

duration: undefined | string
member

{string} [duration] Time elapsed during the execution of this job.

Optional endTime

endTime: Date
member

{Date} [endTime] The end time.

Optional entityFriendlyName

entityFriendlyName: undefined | string
member

{string} [entityFriendlyName] Friendly name of the entity on which the current job is executing.

Optional errorDetails

errorDetails: AzureIaaSVMErrorInfo[]
member

{AzureIaaSVMErrorInfo[]} [errorDetails] Error details on execution of this job.

Optional extendedInfo

extendedInfo: AzureIaaSVMJobExtendedInfo
member

{AzureIaaSVMJobExtendedInfo} [extendedInfo] Additional information for this job.

jobType

jobType: "AzureIaaSVMJob"
member

{string} jobType Polymorphic Discriminator

Optional operation

operation: undefined | string
member

{string} [operation] The operation name.

serializedName

serializedName: string = "AzureIaaSVMJob"

Optional startTime

startTime: Date
member

{Date} [startTime] The start time.

Optional status

status: undefined | string
member

{string} [status] Job status.

Optional virtualMachineVersion

virtualMachineVersion: undefined | string
member

{string} [virtualMachineVersion] Specifies whether the backup item is a Classic or an Azure Resource Manager VM.

type

type: object

className

className: string = "AzureIaaSVMJob"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Job.type.polymorphicDiscriminator

uberParent

uberParent: string = "Job"

modelProperties

modelProperties: object

actionsInfo

actionsInfo: object

serializedName

serializedName: string = "actionsInfo"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["Invalid","Cancellable","Retriable"]

name

name: "Enum" = "Enum"

duration

duration: object

serializedName

serializedName: string = "duration"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

errorDetails

errorDetails: object

serializedName

serializedName: string = "errorDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureIaaSVMErrorInfo"

name

name: "Composite" = "Composite"

extendedInfo

extendedInfo: object

serializedName

serializedName: string = "extendedInfo"

type

type: object

className

className: string = "AzureIaaSVMJobExtendedInfo"

name

name: "Composite" = "Composite"

virtualMachineVersion

virtualMachineVersion: object

serializedName

serializedName: string = "virtualMachineVersion"

type

type: object

name

name: "String" = "String"

Const AzureIaaSVMJobExtendedInfo

AzureIaaSVMJobExtendedInfo: object
interface

An interface representing AzureIaaSVMJobExtendedInfo. Azure IaaS VM workload-specific additional information for job.

Optional dynamicErrorMessage

dynamicErrorMessage: undefined | string
member

{string} [dynamicErrorMessage] Non localized error message on job execution.

Optional estimatedRemainingDuration

estimatedRemainingDuration: undefined | string
member

{string} [estimatedRemainingDuration] Time remaining for execution of this job.

Optional internalPropertyBag

internalPropertyBag: undefined | object
member

{{ [propertyName: string]: string }} [internalPropertyBag] Job internal properties.

Optional progressPercentage

progressPercentage: undefined | number
member

{number} [progressPercentage] Indicates progress of the job. Null if it has not started or completed.

Optional propertyBag

propertyBag: undefined | object
member

{{ [propertyName: string]: string }} [propertyBag] Job properties.

serializedName

serializedName: string = "AzureIaaSVMJobExtendedInfo"

Optional tasksList

tasksList: AzureIaaSVMJobTaskDetails[]
member

{AzureIaaSVMJobTaskDetails[]} [tasksList] List of tasks associated with this job.

type

type: object

className

className: string = "AzureIaaSVMJobExtendedInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dynamicErrorMessage

dynamicErrorMessage: object

serializedName

serializedName: string = "dynamicErrorMessage"

type

type: object

name

name: "String" = "String"

estimatedRemainingDuration

estimatedRemainingDuration: object

serializedName

serializedName: string = "estimatedRemainingDuration"

type

type: object

name

name: "String" = "String"

internalPropertyBag

internalPropertyBag: object

serializedName

serializedName: string = "internalPropertyBag"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

progressPercentage

progressPercentage: object

serializedName

serializedName: string = "progressPercentage"

type

type: object

name

name: "Number" = "Number"

propertyBag

propertyBag: object

serializedName

serializedName: string = "propertyBag"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

tasksList

tasksList: object

serializedName

serializedName: string = "tasksList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureIaaSVMJobTaskDetails"

name

name: "Composite" = "Composite"

Const AzureIaaSVMJobTaskDetails

AzureIaaSVMJobTaskDetails: object
interface

An interface representing AzureIaaSVMJobTaskDetails. Azure IaaS VM workload-specific job task details.

Optional duration

duration: undefined | string
member

{string} [duration] Time elapsed for task.

Optional endTime

endTime: Date
member

{Date} [endTime] The end time.

Optional instanceId

instanceId: undefined | string
member

{string} [instanceId] The instanceId.

Optional progressPercentage

progressPercentage: undefined | number
member

{number} [progressPercentage] Progress of the task.

serializedName

serializedName: string = "AzureIaaSVMJobTaskDetails"

Optional startTime

startTime: Date
member

{Date} [startTime] The start time.

Optional status

status: undefined | string
member

{string} [status] The status.

Optional taskExecutionDetails

taskExecutionDetails: undefined | string
member

{string} [taskExecutionDetails] Details about execution of the task. eg: number of bytes transfered etc

Optional taskId

taskId: undefined | string
member

{string} [taskId] The task display name.

type

type: object

className

className: string = "AzureIaaSVMJobTaskDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

duration

duration: object

serializedName

serializedName: string = "duration"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

instanceId

instanceId: object

serializedName

serializedName: string = "instanceId"

type

type: object

name

name: "String" = "String"

progressPercentage

progressPercentage: object

serializedName

serializedName: string = "progressPercentage"

type

type: object

name

name: "Number" = "Number"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

taskExecutionDetails

taskExecutionDetails: object

serializedName

serializedName: string = "taskExecutionDetails"

type

type: object

name

name: "String" = "String"

taskId

taskId: object

serializedName

serializedName: string = "taskId"

type

type: object

name

name: "String" = "String"

Const AzureIaaSVMProtectedItem

AzureIaaSVMProtectedItem: object
interface

An interface representing AzureIaaSVMProtectedItem. IaaS VM workload-specific backup item.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional backupSetName

backupSetName: undefined | string
member

{string} [backupSetName] Name of the backup set the backup item belongs to

Optional containerName

containerName: undefined | string
member

{string} [containerName] Unique name of container

Optional createMode

createMode: CreateMode
member

{CreateMode} [createMode] Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: 'Invalid', 'Default', 'Recover'

Optional extendedInfo

extendedInfo: AzureIaaSVMProtectedItemExtendedInfo
member

{AzureIaaSVMProtectedItemExtendedInfo} [extendedInfo] Additional information for this backup item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the VM represented by this backup item.

Optional healthDetails

healthDetails: AzureIaaSVMHealthDetails[]
member

{AzureIaaSVMHealthDetails[]} [healthDetails] Health details on this backup item.

Optional healthStatus

healthStatus: HealthStatus
member

{HealthStatus} [healthStatus] Health status of protected item. Possible values include: 'Passed', 'ActionRequired', 'ActionSuggested', 'Invalid'

Optional lastBackupStatus

lastBackupStatus: undefined | string
member

{string} [lastBackupStatus] Last backup operation status.

Optional lastBackupTime

lastBackupTime: Date
member

{Date} [lastBackupTime] Timestamp of the last backup operation on this backup item.

Optional lastRecoveryPoint

lastRecoveryPoint: Date
member

{Date} [lastRecoveryPoint] Timestamp when the last (latest) backup copy was created for this backup item.

Optional policyId

policyId: undefined | string
member

{string} [policyId] ID of the backup policy with which this item is backed up.

Optional protectedItemDataId

protectedItemDataId: undefined | string
member

{string} [protectedItemDataId] Data ID of the protected item.

protectedItemType

protectedItemType: "AzureIaaSVMProtectedItem"
member

{string} protectedItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionState
member

{ProtectionState} [protectionState] Backup state of this backup item. Possible values include: 'Invalid', 'IRPending', 'Protected', 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'

Optional protectionStatus

protectionStatus: undefined | string
member

{string} [protectionStatus] Backup status of this backup item.

serializedName

serializedName: string = "AzureIaaSVMProtectedItem"

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] ARM ID of the resource to be backed up.

Optional virtualMachineId

virtualMachineId: undefined | string
member

{string} [virtualMachineId] Fully qualified ARM ID of the virtual machine represented by this item.

Optional workloadType

workloadType: DataSourceType
member

{DataSourceType} [workloadType] Type of workload this item represents. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

type

type: object

className

className: string = "AzureIaaSVMProtectedItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectedItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectedItem"

modelProperties

modelProperties: object

extendedInfo

extendedInfo: object

serializedName

serializedName: string = "extendedInfo"

type

type: object

className

className: string = "AzureIaaSVMProtectedItemExtendedInfo"

name

name: "Composite" = "Composite"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

healthDetails

healthDetails: object

serializedName

serializedName: string = "healthDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureIaaSVMHealthDetails"

name

name: "Composite" = "Composite"

healthStatus

healthStatus: object

serializedName

serializedName: string = "healthStatus"

type

type: object

name

name: "String" = "String"

lastBackupStatus

lastBackupStatus: object

serializedName

serializedName: string = "lastBackupStatus"

type

type: object

name

name: "String" = "String"

lastBackupTime

lastBackupTime: object

serializedName

serializedName: string = "lastBackupTime"

type

type: object

name

name: "DateTime" = "DateTime"

protectedItemDataId

protectedItemDataId: object

serializedName

serializedName: string = "protectedItemDataId"

type

type: object

name

name: "String" = "String"

protectionState

protectionState: object

serializedName

serializedName: string = "protectionState"

type

type: object

name

name: "String" = "String"

protectionStatus

protectionStatus: object

serializedName

serializedName: string = "protectionStatus"

type

type: object

name

name: "String" = "String"

virtualMachineId

virtualMachineId: object

serializedName

serializedName: string = "virtualMachineId"

type

type: object

name

name: "String" = "String"

Const AzureIaaSVMProtectedItemExtendedInfo

AzureIaaSVMProtectedItemExtendedInfo: object
interface

An interface representing AzureIaaSVMProtectedItemExtendedInfo. Additional information on Azure IaaS VM specific backup item.

Optional oldestRecoveryPoint

oldestRecoveryPoint: Date
member

{Date} [oldestRecoveryPoint] The oldest backup copy available for this backup item.

Optional policyInconsistent

policyInconsistent: undefined | false | true
member

{boolean} [policyInconsistent] Specifies if backup policy associated with the backup item is inconsistent.

Optional recoveryPointCount

recoveryPointCount: undefined | number
member

{number} [recoveryPointCount] Number of backup copies available for this backup item.

serializedName

serializedName: string = "AzureIaaSVMProtectedItemExtendedInfo"

type

type: object

className

className: string = "AzureIaaSVMProtectedItemExtendedInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

oldestRecoveryPoint

oldestRecoveryPoint: object

serializedName

serializedName: string = "oldestRecoveryPoint"

type

type: object

name

name: "DateTime" = "DateTime"

policyInconsistent

policyInconsistent: object

serializedName

serializedName: string = "policyInconsistent"

type

type: object

name

name: "Boolean" = "Boolean"

recoveryPointCount

recoveryPointCount: object

serializedName

serializedName: string = "recoveryPointCount"

type

type: object

name

name: "Number" = "Number"

Const AzureIaaSVMProtectionPolicy

AzureIaaSVMProtectionPolicy: object
interface

An interface representing AzureIaaSVMProtectionPolicy. IaaS VM workload-specific backup policy.

backupManagementType

backupManagementType: "AzureIaasVM"
member

{string} backupManagementType Polymorphic Discriminator

Optional instantRpRetentionRangeInDays

instantRpRetentionRangeInDays: undefined | number
member

{number} [instantRpRetentionRangeInDays] Instant RP retention policy range in days

Optional protectedItemsCount

protectedItemsCount: undefined | number
member

{number} [protectedItemsCount] Number of items associated with this policy.

Optional retentionPolicy

retentionPolicy: RetentionPolicyUnion
member

{RetentionPolicyUnion} [retentionPolicy] Retention policy with the details on backup copy retention ranges.

Optional schedulePolicy

schedulePolicy: SchedulePolicyUnion
member

{SchedulePolicyUnion} [schedulePolicy] Backup schedule specified as part of backup policy.

serializedName

serializedName: string = "AzureIaasVM"

Optional timeZone

timeZone: undefined | string
member

{string} [timeZone] TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time".

type

type: object

className

className: string = "AzureIaaSVMProtectionPolicy"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionPolicy.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionPolicy"

modelProperties

modelProperties: object

instantRpRetentionRangeInDays

instantRpRetentionRangeInDays: object

serializedName

serializedName: string = "instantRpRetentionRangeInDays"

type

type: object

name

name: "Number" = "Number"

retentionPolicy

retentionPolicy: object

serializedName

serializedName: string = "retentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

name: "Composite" = "Composite"

schedulePolicy

schedulePolicy: object

serializedName

serializedName: string = "schedulePolicy"

type

type: object

className

className: string = "SchedulePolicy"

name

name: "Composite" = "Composite"

timeZone

timeZone: object

serializedName

serializedName: string = "timeZone"

type

type: object

name

name: "String" = "String"

Const AzureRecoveryServiceVaultProtectionIntent

AzureRecoveryServiceVaultProtectionIntent: object
interface

An interface representing AzureRecoveryServiceVaultProtectionIntent. Azure Recovery Services Vault specific protection intent item.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional itemId

itemId: undefined | string
member

{string} [itemId] ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId

Optional policyId

policyId: undefined | string
member

{string} [policyId] ID of the backup policy with which this item is backed up.

protectionIntentItemType

protectionIntentItemType: "RecoveryServiceVaultItem"
member

{string} protectionIntentItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionStatus
member

{ProtectionStatus} [protectionState] Backup state of this backup item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "RecoveryServiceVaultItem"

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] ARM ID of the resource to be backed up.

type

type: object

className

className: string = "AzureRecoveryServiceVaultProtectionIntent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionIntent.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionIntent"

modelProperties

modelProperties: object

Const AzureResourceProtectionIntent

AzureResourceProtectionIntent: object
interface

An interface representing AzureResourceProtectionIntent. IaaS VM specific backup protection intent item.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the VM represented by this backup item.

Optional itemId

itemId: undefined | string
member

{string} [itemId] ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId

Optional policyId

policyId: undefined | string
member

{string} [policyId] ID of the backup policy with which this item is backed up.

protectionIntentItemType

protectionIntentItemType: "AzureResourceItem"
member

{string} protectionIntentItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionStatus
member

{ProtectionStatus} [protectionState] Backup state of this backup item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "AzureResourceItem"

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] ARM ID of the resource to be backed up.

type

type: object

className

className: string = "AzureResourceProtectionIntent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionIntent.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionIntent"

modelProperties

modelProperties: object

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

Const AzureSQLAGWorkloadContainerProtectionContainer

AzureSQLAGWorkloadContainerProtectionContainer: object
interface

An interface representing AzureSQLAGWorkloadContainerProtectionContainer. Container for SQL workloads under SQL Availability Group.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

containerType

containerType: "SQLAGWorkLoadContainer"
member

{string} containerType Polymorphic Discriminator

Optional extendedInfo

extendedInfo: AzureWorkloadContainerExtendedInfo
member

{AzureWorkloadContainerExtendedInfo} [extendedInfo] Additional details of a workload container.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the container.

Optional healthStatus

healthStatus: undefined | string
member

{string} [healthStatus] Status of health of the container.

Optional lastUpdatedTime

lastUpdatedTime: Date
member

{Date} [lastUpdatedTime] Time stamp when this container was updated.

Optional registrationStatus

registrationStatus: undefined | string
member

{string} [registrationStatus] Status of registration of the container with the Recovery Services Vault.

serializedName

serializedName: string = "SQLAGWorkLoadContainer"

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] ARM ID of the virtual machine represented by this Azure Workload Container

Optional workloadType

workloadType: WorkloadType
member

{WorkloadType} [workloadType] Workload type for which registration was sent. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

type

type: object

className

className: string = "AzureSQLAGWorkloadContainerProtectionContainer"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionContainer.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionContainer"

modelProperties

modelProperties: object

Const AzureSqlContainer

AzureSqlContainer: object
interface

An interface representing AzureSqlContainer. Azure Sql workload-specific container.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

containerType

containerType: "AzureSqlContainer"
member

{string} containerType Polymorphic Discriminator

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the container.

Optional healthStatus

healthStatus: undefined | string
member

{string} [healthStatus] Status of health of the container.

Optional registrationStatus

registrationStatus: undefined | string
member

{string} [registrationStatus] Status of registration of the container with the Recovery Services Vault.

serializedName

serializedName: string = "AzureSqlContainer"

type

type: object

className

className: string = "AzureSqlContainer"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionContainer.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionContainer"

modelProperties

modelProperties: object

Const AzureSqlProtectedItem

AzureSqlProtectedItem: object
interface

An interface representing AzureSqlProtectedItem. Azure SQL workload-specific backup item.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional backupSetName

backupSetName: undefined | string
member

{string} [backupSetName] Name of the backup set the backup item belongs to

Optional containerName

containerName: undefined | string
member

{string} [containerName] Unique name of container

Optional createMode

createMode: CreateMode
member

{CreateMode} [createMode] Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: 'Invalid', 'Default', 'Recover'

Optional extendedInfo

extendedInfo: AzureSqlProtectedItemExtendedInfo
member

{AzureSqlProtectedItemExtendedInfo} [extendedInfo] Additional information for this backup item.

Optional lastRecoveryPoint

lastRecoveryPoint: Date
member

{Date} [lastRecoveryPoint] Timestamp when the last (latest) backup copy was created for this backup item.

Optional policyId

policyId: undefined | string
member

{string} [policyId] ID of the backup policy with which this item is backed up.

Optional protectedItemDataId

protectedItemDataId: undefined | string
member

{string} [protectedItemDataId] Internal ID of a backup item. Used by Azure SQL Backup engine to contact Recovery Services.

protectedItemType

protectedItemType: "Microsoft.Sql/servers/databases"
member

{string} protectedItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectedItemState
member

{ProtectedItemState} [protectionState] Backup state of the backed up item. Possible values include: 'Invalid', 'IRPending', 'Protected', 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'

serializedName

serializedName: string = "Microsoft.Sql/servers/databases"

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] ARM ID of the resource to be backed up.

Optional workloadType

workloadType: DataSourceType
member

{DataSourceType} [workloadType] Type of workload this item represents. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

type

type: object

className

className: string = "AzureSqlProtectedItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectedItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectedItem"

modelProperties

modelProperties: object

extendedInfo

extendedInfo: object

serializedName

serializedName: string = "extendedInfo"

type

type: object

className

className: string = "AzureSqlProtectedItemExtendedInfo"

name

name: "Composite" = "Composite"

protectedItemDataId

protectedItemDataId: object

serializedName

serializedName: string = "protectedItemDataId"

type

type: object

name

name: "String" = "String"

protectionState

protectionState: object

serializedName

serializedName: string = "protectionState"

type

type: object

name

name: "String" = "String"

Const AzureSqlProtectedItemExtendedInfo

AzureSqlProtectedItemExtendedInfo: object
interface

An interface representing AzureSqlProtectedItemExtendedInfo. Additional information on Azure Sql specific protected item.

Optional oldestRecoveryPoint

oldestRecoveryPoint: Date
member

{Date} [oldestRecoveryPoint] The oldest backup copy available for this item in the service.

Optional policyState

policyState: undefined | string
member

{string} [policyState] State of the backup policy associated with this backup item.

Optional recoveryPointCount

recoveryPointCount: undefined | number
member

{number} [recoveryPointCount] Number of available backup copies associated with this backup item.

serializedName

serializedName: string = "AzureSqlProtectedItemExtendedInfo"

type

type: object

className

className: string = "AzureSqlProtectedItemExtendedInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

oldestRecoveryPoint

oldestRecoveryPoint: object

serializedName

serializedName: string = "oldestRecoveryPoint"

type

type: object

name

name: "DateTime" = "DateTime"

policyState

policyState: object

serializedName

serializedName: string = "policyState"

type

type: object

name

name: "String" = "String"

recoveryPointCount

recoveryPointCount: object

serializedName

serializedName: string = "recoveryPointCount"

type

type: object

name

name: "Number" = "Number"

Const AzureSqlProtectionPolicy

AzureSqlProtectionPolicy: object
interface

An interface representing AzureSqlProtectionPolicy. Azure SQL workload-specific backup policy.

backupManagementType

backupManagementType: "AzureSql"
member

{string} backupManagementType Polymorphic Discriminator

Optional protectedItemsCount

protectedItemsCount: undefined | number
member

{number} [protectedItemsCount] Number of items associated with this policy.

Optional retentionPolicy

retentionPolicy: RetentionPolicyUnion
member

{RetentionPolicyUnion} [retentionPolicy] Retention policy details.

serializedName

serializedName: string = "AzureSql"

type

type: object

className

className: string = "AzureSqlProtectionPolicy"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionPolicy.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionPolicy"

modelProperties

modelProperties: object

retentionPolicy

retentionPolicy: object

serializedName

serializedName: string = "retentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

name: "Composite" = "Composite"

Const AzureStorageContainer

AzureStorageContainer: object
interface

An interface representing AzureStorageContainer. Azure Storage Account workload-specific container.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

containerType

containerType: "StorageContainer"
member

{string} containerType Polymorphic Discriminator

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the container.

Optional healthStatus

healthStatus: undefined | string
member

{string} [healthStatus] Status of health of the container.

Optional protectedItemCount

protectedItemCount: undefined | number
member

{number} [protectedItemCount] Number of items backed up in this container.

Optional registrationStatus

registrationStatus: undefined | string
member

{string} [registrationStatus] Status of registration of the container with the Recovery Services Vault.

Optional resourceGroup

resourceGroup: undefined | string
member

{string} [resourceGroup] Resource group name of Recovery Services Vault.

serializedName

serializedName: string = "StorageContainer"

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] Fully qualified ARM url.

Optional storageAccountVersion

storageAccountVersion: undefined | string
member

{string} [storageAccountVersion] Storage account version.

type

type: object

className

className: string = "AzureStorageContainer"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionContainer.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionContainer"

modelProperties

modelProperties: object

protectedItemCount

protectedItemCount: object

serializedName

serializedName: string = "protectedItemCount"

type

type: object

name

name: "Number" = "Number"

resourceGroup

resourceGroup: object

serializedName

serializedName: string = "resourceGroup"

type

type: object

name

name: "String" = "String"

sourceResourceId

sourceResourceId: object

serializedName

serializedName: string = "sourceResourceId"

type

type: object

name

name: "String" = "String"

storageAccountVersion

storageAccountVersion: object

serializedName

serializedName: string = "storageAccountVersion"

type

type: object

name

name: "String" = "String"

Const AzureStorageErrorInfo

AzureStorageErrorInfo: object
interface

An interface representing AzureStorageErrorInfo. Azure storage specific error information

Optional errorCode

errorCode: undefined | number
member

{number} [errorCode] Error code.

Optional errorString

errorString: undefined | string
member

{string} [errorString] Localized error string.

Optional recommendations

recommendations: string[]
member

{string[]} [recommendations] List of localized recommendations for above error code.

serializedName

serializedName: string = "AzureStorageErrorInfo"

type

type: object

className

className: string = "AzureStorageErrorInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "errorCode"

type

type: object

name

name: "Number" = "Number"

errorString

errorString: object

serializedName

serializedName: string = "errorString"

type

type: object

name

name: "String" = "String"

recommendations

recommendations: object

serializedName

serializedName: string = "recommendations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const AzureStorageJob

AzureStorageJob: object
interface

An interface representing AzureStorageJob. Azure storage specific job.

Optional actionsInfo

actionsInfo: JobSupportedAction[]
member

{JobSupportedAction[]} [actionsInfo] Gets or sets the state/actions applicable on this job like cancel/retry.

Optional activityId

activityId: undefined | string
member

{string} [activityId] ActivityId of job.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Backup management type to execute the current job. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional duration

duration: undefined | string
member

{string} [duration] Time elapsed during the execution of this job.

Optional endTime

endTime: Date
member

{Date} [endTime] The end time.

Optional entityFriendlyName

entityFriendlyName: undefined | string
member

{string} [entityFriendlyName] Friendly name of the entity on which the current job is executing.

Optional errorDetails

errorDetails: AzureStorageErrorInfo[]
member

{AzureStorageErrorInfo[]} [errorDetails] Error details on execution of this job.

Optional extendedInfo

extendedInfo: AzureStorageJobExtendedInfo
member

{AzureStorageJobExtendedInfo} [extendedInfo] Additional information about the job.

jobType

jobType: "AzureStorageJob"
member

{string} jobType Polymorphic Discriminator

Optional operation

operation: undefined | string
member

{string} [operation] The operation name.

serializedName

serializedName: string = "AzureStorageJob"

Optional startTime

startTime: Date
member

{Date} [startTime] The start time.

Optional status

status: undefined | string
member

{string} [status] Job status.

Optional storageAccountName

storageAccountName: undefined | string
member

{string} [storageAccountName] Specifies friendly name of the storage account.

Optional storageAccountVersion

storageAccountVersion: undefined | string
member

{string} [storageAccountVersion] Specifies whether the Storage account is a Classic or an Azure Resource Manager Storage account.

type

type: object

className

className: string = "AzureStorageJob"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Job.type.polymorphicDiscriminator

uberParent

uberParent: string = "Job"

modelProperties

modelProperties: object

actionsInfo

actionsInfo: object

serializedName

serializedName: string = "actionsInfo"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["Invalid","Cancellable","Retriable"]

name

name: "Enum" = "Enum"

duration

duration: object

serializedName

serializedName: string = "duration"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

errorDetails

errorDetails: object

serializedName

serializedName: string = "errorDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureStorageErrorInfo"

name

name: "Composite" = "Composite"

extendedInfo

extendedInfo: object

serializedName

serializedName: string = "extendedInfo"

type

type: object

className

className: string = "AzureStorageJobExtendedInfo"

name

name: "Composite" = "Composite"

storageAccountName

storageAccountName: object

serializedName

serializedName: string = "storageAccountName"

type

type: object

name

name: "String" = "String"

storageAccountVersion

storageAccountVersion: object

serializedName

serializedName: string = "storageAccountVersion"

type

type: object

name

name: "String" = "String"

Const AzureStorageJobExtendedInfo

AzureStorageJobExtendedInfo: object
interface

An interface representing AzureStorageJobExtendedInfo. Azure Storage workload-specific additional information for job.

Optional dynamicErrorMessage

dynamicErrorMessage: undefined | string
member

{string} [dynamicErrorMessage] Non localized error message on job execution.

Optional propertyBag

propertyBag: undefined | object
member

{{ [propertyName: string]: string }} [propertyBag] Job properties.

serializedName

serializedName: string = "AzureStorageJobExtendedInfo"

Optional tasksList

tasksList: AzureStorageJobTaskDetails[]
member

{AzureStorageJobTaskDetails[]} [tasksList] List of tasks for this job

type

type: object

className

className: string = "AzureStorageJobExtendedInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dynamicErrorMessage

dynamicErrorMessage: object

serializedName

serializedName: string = "dynamicErrorMessage"

type

type: object

name

name: "String" = "String"

propertyBag

propertyBag: object

serializedName

serializedName: string = "propertyBag"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

tasksList

tasksList: object

serializedName

serializedName: string = "tasksList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureStorageJobTaskDetails"

name

name: "Composite" = "Composite"

Const AzureStorageJobTaskDetails

AzureStorageJobTaskDetails: object
interface

An interface representing AzureStorageJobTaskDetails. Azure storage workload specific job task details.

serializedName

serializedName: string = "AzureStorageJobTaskDetails"

Optional status

status: undefined | string
member

{string} [status] The status.

Optional taskId

taskId: undefined | string
member

{string} [taskId] The task display name.

type

type: object

className

className: string = "AzureStorageJobTaskDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

taskId

taskId: object

serializedName

serializedName: string = "taskId"

type

type: object

name

name: "String" = "String"

Const AzureStorageProtectableContainer

AzureStorageProtectableContainer: object
interface

An interface representing AzureStorageProtectableContainer. Azure Storage-specific protectable containers

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional containerId

containerId: undefined | string
member

{string} [containerId] Fabric Id of the container such as ARM Id.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the container.

Optional healthStatus

healthStatus: undefined | string
member

{string} [healthStatus] Status of health of the container.

protectableContainerType

protectableContainerType: "StorageContainer"
member

{string} protectableContainerType Polymorphic Discriminator

serializedName

serializedName: string = "StorageContainer"

type

type: object

className

className: string = "AzureStorageProtectableContainer"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectableContainer.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectableContainer"

modelProperties

modelProperties: object

Const AzureVMAppContainerProtectableContainer

AzureVMAppContainerProtectableContainer: object
interface

An interface representing AzureVMAppContainerProtectableContainer. Azure workload-specific container

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional containerId

containerId: undefined | string
member

{string} [containerId] Fabric Id of the container such as ARM Id.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the container.

Optional healthStatus

healthStatus: undefined | string
member

{string} [healthStatus] Status of health of the container.

protectableContainerType

protectableContainerType: "VMAppContainer"
member

{string} protectableContainerType Polymorphic Discriminator

serializedName

serializedName: string = "VMAppContainer"

type

type: object

className

className: string = "AzureVMAppContainerProtectableContainer"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectableContainer.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectableContainer"

modelProperties

modelProperties: object

Const AzureVMAppContainerProtectionContainer

AzureVMAppContainerProtectionContainer: object
interface

An interface representing AzureVMAppContainerProtectionContainer. Container for SQL workloads under Azure Virtual Machines.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

containerType

containerType: "VMAppContainer"
member

{string} containerType Polymorphic Discriminator

Optional extendedInfo

extendedInfo: AzureWorkloadContainerExtendedInfo
member

{AzureWorkloadContainerExtendedInfo} [extendedInfo] Additional details of a workload container.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the container.

Optional healthStatus

healthStatus: undefined | string
member

{string} [healthStatus] Status of health of the container.

Optional lastUpdatedTime

lastUpdatedTime: Date
member

{Date} [lastUpdatedTime] Time stamp when this container was updated.

Optional registrationStatus

registrationStatus: undefined | string
member

{string} [registrationStatus] Status of registration of the container with the Recovery Services Vault.

serializedName

serializedName: string = "VMAppContainer"

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] ARM ID of the virtual machine represented by this Azure Workload Container

Optional workloadType

workloadType: WorkloadType
member

{WorkloadType} [workloadType] Workload type for which registration was sent. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

type

type: object

className

className: string = "AzureVMAppContainerProtectionContainer"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionContainer.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionContainer"

modelProperties

modelProperties: object

Const AzureVMResourceFeatureSupportRequest

AzureVMResourceFeatureSupportRequest: object
interface

An interface representing AzureVMResourceFeatureSupportRequest. AzureResource(IaaS VM) Specific feature support request

featureType

featureType: "AzureVMResourceBackup"
member

{string} featureType Polymorphic Discriminator

serializedName

serializedName: string = "AzureVMResourceBackup"

Optional vmSize

vmSize: undefined | string
member

{string} [vmSize] Size of the resource: VM size(A/D series etc) in case of IaasVM

Optional vmSku

vmSku: undefined | string
member

{string} [vmSku] SKUs (Premium/Managed etc) in case of IaasVM

type

type: object

className

className: string = "AzureVMResourceFeatureSupportRequest"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = FeatureSupportRequest.type.polymorphicDiscriminator

uberParent

uberParent: string = "FeatureSupportRequest"

modelProperties

modelProperties: object

vmSize

vmSize: object

serializedName

serializedName: string = "vmSize"

type

type: object

name

name: "String" = "String"

vmSku

vmSku: object

serializedName

serializedName: string = "vmSku"

type

type: object

name

name: "String" = "String"

Const AzureVMResourceFeatureSupportResponse

AzureVMResourceFeatureSupportResponse: object
interface

An interface representing AzureVMResourceFeatureSupportResponse. Response for feature support requests for Azure IaasVm

serializedName

serializedName: string = "AzureVMResourceFeatureSupportResponse"

Optional supportStatus

supportStatus: SupportStatus
member

{SupportStatus} [supportStatus] Support status of feature. Possible values include: 'Invalid', 'Supported', 'DefaultOFF', 'DefaultON', 'NotSupported'

type

type: object

className

className: string = "AzureVMResourceFeatureSupportResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

supportStatus

supportStatus: object

serializedName

serializedName: string = "supportStatus"

type

type: object

name

name: "String" = "String"

Const AzureVmWorkloadItem

AzureVmWorkloadItem: object
interface

An interface representing AzureVmWorkloadItem. Azure VM workload-specific workload item.

Optional backupManagementType

backupManagementType: undefined | string
member

{string} [backupManagementType] Type of backup managemenent to backup an item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the backup item.

Optional isAutoProtectable

isAutoProtectable: undefined | false | true
member

{boolean} [isAutoProtectable] Indicates if workload item is auto-protectable

Optional parentName

parentName: undefined | string
member

{string} [parentName] Name for instance or AG

Optional protectionState

protectionState: ProtectionStatus
member

{ProtectionStatus} [protectionState] State of the back up item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "AzureVmWorkloadItem"

Optional serverName

serverName: undefined | string
member

{string} [serverName] Host/Cluster Name for instance or AG

Optional subWorkloadItemCount

subWorkloadItemCount: undefined | number
member

{number} [subWorkloadItemCount] For instance or AG, indicates number of DB's to be protected

Optional subinquireditemcount

subinquireditemcount: undefined | number
member

{number} [subinquireditemcount] For instance or AG, indicates number of DB's present

workloadItemType

workloadItemType: "AzureVmWorkloadItem"
member

{string} workloadItemType Polymorphic Discriminator

Optional workloadType

workloadType: undefined | string
member

{string} [workloadType] Type of workload for the backup management

type

type: object

className

className: string = "AzureVmWorkloadItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = WorkloadItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "WorkloadItem"

modelProperties

modelProperties: object

isAutoProtectable

isAutoProtectable: object

serializedName

serializedName: string = "isAutoProtectable"

type

type: object

name

name: "Boolean" = "Boolean"

parentName

parentName: object

serializedName

serializedName: string = "parentName"

type

type: object

name

name: "String" = "String"

serverName

serverName: object

serializedName

serializedName: string = "serverName"

type

type: object

name

name: "String" = "String"

subWorkloadItemCount

subWorkloadItemCount: object

serializedName

serializedName: string = "subWorkloadItemCount"

type

type: object

name

name: "Number" = "Number"

subinquireditemcount

subinquireditemcount: object

serializedName

serializedName: string = "subinquireditemcount"

type

type: object

name

name: "Number" = "Number"

Const AzureVmWorkloadProtectableItem

AzureVmWorkloadProtectableItem: object
interface

An interface representing AzureVmWorkloadProtectableItem. Azure VM workload-specific protectable item.

Optional backupManagementType

backupManagementType: undefined | string
member

{string} [backupManagementType] Type of backup managemenent to backup an item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the backup item.

Optional isAutoProtectable

isAutoProtectable: undefined | false | true
member

{boolean} [isAutoProtectable] Indicates if protectable item is auto-protectable

Optional isAutoProtected

isAutoProtected: undefined | false | true
member

{boolean} [isAutoProtected] Indicates if protectable item is auto-protected

Optional parentName

parentName: undefined | string
member

{string} [parentName] Name for instance or AG

Optional parentUniqueName

parentUniqueName: undefined | string
member

{string} [parentUniqueName] Parent Unique Name is added to provide the service formatted URI Name of the Parent Only Applicable for data bases where the parent would be either Instance or a SQL AG.

Optional prebackupvalidation

prebackupvalidation: PreBackupValidation
member

{PreBackupValidation} [prebackupvalidation] Pre-backup validation for protectable objects

protectableItemType

protectableItemType: "AzureVmWorkloadProtectableItem"
member

{string} protectableItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionStatus
member

{ProtectionStatus} [protectionState] State of the back up item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "AzureVmWorkloadProtectableItem"

Optional serverName

serverName: undefined | string
member

{string} [serverName] Host/Cluster Name for instance or AG

Optional subinquireditemcount

subinquireditemcount: undefined | number
member

{number} [subinquireditemcount] For instance or AG, indicates number of DB's present

Optional subprotectableitemcount

subprotectableitemcount: undefined | number
member

{number} [subprotectableitemcount] For instance or AG, indicates number of DB's to be protected

Optional workloadType

workloadType: undefined | string
member

{string} [workloadType] Type of workload for the backup management

type

type: object

className

className: string = "AzureVmWorkloadProtectableItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = WorkloadProtectableItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "WorkloadProtectableItem"

modelProperties

modelProperties: object

isAutoProtectable

isAutoProtectable: object

serializedName

serializedName: string = "isAutoProtectable"

type

type: object

name

name: "Boolean" = "Boolean"

isAutoProtected

isAutoProtected: object

serializedName

serializedName: string = "isAutoProtected"

type

type: object

name

name: "Boolean" = "Boolean"

parentName

parentName: object

serializedName

serializedName: string = "parentName"

type

type: object

name

name: "String" = "String"

parentUniqueName

parentUniqueName: object

serializedName

serializedName: string = "parentUniqueName"

type

type: object

name

name: "String" = "String"

prebackupvalidation

prebackupvalidation: object

serializedName

serializedName: string = "prebackupvalidation"

type

type: object

className

className: string = "PreBackupValidation"

name

name: "Composite" = "Composite"

serverName

serverName: object

serializedName

serializedName: string = "serverName"

type

type: object

name

name: "String" = "String"

subinquireditemcount

subinquireditemcount: object

serializedName

serializedName: string = "subinquireditemcount"

type

type: object

name

name: "Number" = "Number"

subprotectableitemcount

subprotectableitemcount: object

serializedName

serializedName: string = "subprotectableitemcount"

type

type: object

name

name: "Number" = "Number"

Const AzureVmWorkloadProtectedItem

AzureVmWorkloadProtectedItem: object
interface

An interface representing AzureVmWorkloadProtectedItem. Azure VM workload-specific protected item.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional backupSetName

backupSetName: undefined | string
member

{string} [backupSetName] Name of the backup set the backup item belongs to

Optional containerName

containerName: undefined | string
member

{string} [containerName] Unique name of container

Optional createMode

createMode: CreateMode
member

{CreateMode} [createMode] Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: 'Invalid', 'Default', 'Recover'

Optional extendedInfo

extendedInfo: AzureVmWorkloadProtectedItemExtendedInfo
member

{AzureVmWorkloadProtectedItemExtendedInfo} [extendedInfo] Additional information for this backup item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the DB represented by this backup item.

Optional lastBackupErrorDetail

lastBackupErrorDetail: ErrorDetail
member

{ErrorDetail} [lastBackupErrorDetail] Error details in last backup

Optional lastBackupStatus

lastBackupStatus: LastBackupStatus
member

{LastBackupStatus} [lastBackupStatus] Last backup operation status. Possible values: Healthy, Unhealthy. Possible values include: 'Invalid', 'Healthy', 'Unhealthy', 'IRPending'

Optional lastBackupTime

lastBackupTime: Date
member

{Date} [lastBackupTime] Timestamp of the last backup operation on this backup item.

Optional lastRecoveryPoint

lastRecoveryPoint: Date
member

{Date} [lastRecoveryPoint] Timestamp when the last (latest) backup copy was created for this backup item.

Optional parentName

parentName: undefined | string
member

{string} [parentName] Parent name of the DB such as Instance or Availability Group.

Optional parentType

parentType: undefined | string
member

{string} [parentType] Parent type of protected item, example: for a DB, standalone server or distributed

Optional policyId

policyId: undefined | string
member

{string} [policyId] ID of the backup policy with which this item is backed up.

Optional protectedItemDataSourceId

protectedItemDataSourceId: undefined | string
member

{string} [protectedItemDataSourceId] Data ID of the protected item.

Optional protectedItemHealthStatus

protectedItemHealthStatus: ProtectedItemHealthStatus
member

{ProtectedItemHealthStatus} [protectedItemHealthStatus] Health status of the backup item, evaluated based on last heartbeat received. Possible values include: 'Invalid', 'Healthy', 'Unhealthy', 'NotReachable', 'IRPending'

protectedItemType

protectedItemType: "AzureVmWorkloadProtectedItem"
member

{string} protectedItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionState
member

{ProtectionState} [protectionState] Backup state of this backup item. Possible values include: 'Invalid', 'IRPending', 'Protected', 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'

Optional protectionStatus

protectionStatus: undefined | string
member

{string} [protectionStatus] Backup status of this backup item.

serializedName

serializedName: string = "AzureVmWorkloadProtectedItem"

Optional serverName

serverName: undefined | string
member

{string} [serverName] Host/Cluster Name for instance or AG

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] ARM ID of the resource to be backed up.

Optional workloadType

workloadType: DataSourceType
member

{DataSourceType} [workloadType] Type of workload this item represents. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

type

type: object

className

className: string = "AzureVmWorkloadProtectedItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectedItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectedItem"

modelProperties

modelProperties: object

extendedInfo

extendedInfo: object

serializedName

serializedName: string = "extendedInfo"

type

type: object

className

className: string = "AzureVmWorkloadProtectedItemExtendedInfo"

name

name: "Composite" = "Composite"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

lastBackupErrorDetail

lastBackupErrorDetail: object

serializedName

serializedName: string = "lastBackupErrorDetail"

type

type: object

className

className: string = "ErrorDetail"

name

name: "Composite" = "Composite"

lastBackupStatus

lastBackupStatus: object

serializedName

serializedName: string = "lastBackupStatus"

type

type: object

name

name: "String" = "String"

lastBackupTime

lastBackupTime: object

serializedName

serializedName: string = "lastBackupTime"

type

type: object

name

name: "DateTime" = "DateTime"

parentName

parentName: object

serializedName

serializedName: string = "parentName"

type

type: object

name

name: "String" = "String"

parentType

parentType: object

serializedName

serializedName: string = "parentType"

type

type: object

name

name: "String" = "String"

protectedItemDataSourceId

protectedItemDataSourceId: object

serializedName

serializedName: string = "protectedItemDataSourceId"

type

type: object

name

name: "String" = "String"

protectedItemHealthStatus

protectedItemHealthStatus: object

serializedName

serializedName: string = "protectedItemHealthStatus"

type

type: object

name

name: "String" = "String"

protectionState

protectionState: object

serializedName

serializedName: string = "protectionState"

type

type: object

name

name: "String" = "String"

protectionStatus

protectionStatus: object

serializedName

serializedName: string = "protectionStatus"

type

type: object

name

name: "String" = "String"

serverName

serverName: object

serializedName

serializedName: string = "serverName"

type

type: object

name

name: "String" = "String"

Const AzureVmWorkloadProtectedItemExtendedInfo

AzureVmWorkloadProtectedItemExtendedInfo: object
interface

An interface representing AzureVmWorkloadProtectedItemExtendedInfo. Additional information on Azure Workload for SQL specific backup item.

Optional oldestRecoveryPoint

oldestRecoveryPoint: Date
member

{Date} [oldestRecoveryPoint] The oldest backup copy available for this backup item.

Optional policyState

policyState: undefined | string
member

{string} [policyState] Indicates consistency of policy object and policy applied to this backup item.

Optional recoveryPointCount

recoveryPointCount: undefined | number
member

{number} [recoveryPointCount] Number of backup copies available for this backup item.

serializedName

serializedName: string = "AzureVmWorkloadProtectedItemExtendedInfo"

type

type: object

className

className: string = "AzureVmWorkloadProtectedItemExtendedInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

oldestRecoveryPoint

oldestRecoveryPoint: object

serializedName

serializedName: string = "oldestRecoveryPoint"

type

type: object

name

name: "DateTime" = "DateTime"

policyState

policyState: object

serializedName

serializedName: string = "policyState"

type

type: object

name

name: "String" = "String"

recoveryPointCount

recoveryPointCount: object

serializedName

serializedName: string = "recoveryPointCount"

type

type: object

name

name: "Number" = "Number"

Const AzureVmWorkloadProtectionPolicy

AzureVmWorkloadProtectionPolicy: object
interface

An interface representing AzureVmWorkloadProtectionPolicy. Azure VM (Mercury) workload-specific backup policy.

backupManagementType

backupManagementType: "AzureWorkload"
member

{string} backupManagementType Polymorphic Discriminator

Optional protectedItemsCount

protectedItemsCount: undefined | number
member

{number} [protectedItemsCount] Number of items associated with this policy.

serializedName

serializedName: string = "AzureWorkload"

Optional settings

settings: Settings
member

{Settings} [settings] Common settings for the backup management

Optional subProtectionPolicy

subProtectionPolicy: SubProtectionPolicy[]
member

{SubProtectionPolicy[]} [subProtectionPolicy] List of sub-protection policies which includes schedule and retention

Optional workLoadType

workLoadType: WorkloadType
member

{WorkloadType} [workLoadType] Type of workload for the backup management. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

type

type: object

className

className: string = "AzureVmWorkloadProtectionPolicy"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionPolicy.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionPolicy"

modelProperties

modelProperties: object

settings

settings: object

serializedName

serializedName: string = "settings"

type

type: object

className

className: string = "Settings"

name

name: "Composite" = "Composite"

subProtectionPolicy

subProtectionPolicy: object

serializedName

serializedName: string = "subProtectionPolicy"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubProtectionPolicy"

name

name: "Composite" = "Composite"

workLoadType

workLoadType: object

serializedName

serializedName: string = "workLoadType"

type

type: object

name

name: "String" = "String"

Const AzureVmWorkloadSAPHanaDatabaseProtectableItem

AzureVmWorkloadSAPHanaDatabaseProtectableItem: object
interface

An interface representing AzureVmWorkloadSAPHanaDatabaseProtectableItem. Azure VM workload-specific protectable item representing SAP Hana Database.

Optional backupManagementType

backupManagementType: undefined | string
member

{string} [backupManagementType] Type of backup managemenent to backup an item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the backup item.

Optional isAutoProtectable

isAutoProtectable: undefined | false | true
member

{boolean} [isAutoProtectable] Indicates if protectable item is auto-protectable

Optional isAutoProtected

isAutoProtected: undefined | false | true
member

{boolean} [isAutoProtected] Indicates if protectable item is auto-protected

Optional parentName

parentName: undefined | string
member

{string} [parentName] Name for instance or AG

Optional parentUniqueName

parentUniqueName: undefined | string
member

{string} [parentUniqueName] Parent Unique Name is added to provide the service formatted URI Name of the Parent Only Applicable for data bases where the parent would be either Instance or a SQL AG.

Optional prebackupvalidation

prebackupvalidation: PreBackupValidation
member

{PreBackupValidation} [prebackupvalidation] Pre-backup validation for protectable objects

protectableItemType

protectableItemType: "SAPHanaDatabase"
member

{string} protectableItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionStatus
member

{ProtectionStatus} [protectionState] State of the back up item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "SAPHanaDatabase"

Optional serverName

serverName: undefined | string
member

{string} [serverName] Host/Cluster Name for instance or AG

Optional subinquireditemcount

subinquireditemcount: undefined | number
member

{number} [subinquireditemcount] For instance or AG, indicates number of DB's present

Optional subprotectableitemcount

subprotectableitemcount: undefined | number
member

{number} [subprotectableitemcount] For instance or AG, indicates number of DB's to be protected

Optional workloadType

workloadType: undefined | string
member

{string} [workloadType] Type of workload for the backup management

type

type: object

className

className: string = "AzureVmWorkloadSAPHanaDatabaseProtectableItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = WorkloadProtectableItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "WorkloadProtectableItem"

modelProperties

modelProperties: object

Const AzureVmWorkloadSAPHanaDatabaseProtectedItem

AzureVmWorkloadSAPHanaDatabaseProtectedItem: object
interface

An interface representing AzureVmWorkloadSAPHanaDatabaseProtectedItem. Azure VM workload-specific protected item representing SAP Hana Database.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional backupSetName

backupSetName: undefined | string
member

{string} [backupSetName] Name of the backup set the backup item belongs to

Optional containerName

containerName: undefined | string
member

{string} [containerName] Unique name of container

Optional createMode

createMode: CreateMode
member

{CreateMode} [createMode] Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: 'Invalid', 'Default', 'Recover'

Optional extendedInfo

extendedInfo: AzureVmWorkloadProtectedItemExtendedInfo
member

{AzureVmWorkloadProtectedItemExtendedInfo} [extendedInfo] Additional information for this backup item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the DB represented by this backup item.

Optional lastBackupErrorDetail

lastBackupErrorDetail: ErrorDetail
member

{ErrorDetail} [lastBackupErrorDetail] Error details in last backup

Optional lastBackupStatus

lastBackupStatus: LastBackupStatus
member

{LastBackupStatus} [lastBackupStatus] Last backup operation status. Possible values: Healthy, Unhealthy. Possible values include: 'Invalid', 'Healthy', 'Unhealthy', 'IRPending'

Optional lastBackupTime

lastBackupTime: Date
member

{Date} [lastBackupTime] Timestamp of the last backup operation on this backup item.

Optional lastRecoveryPoint

lastRecoveryPoint: Date
member

{Date} [lastRecoveryPoint] Timestamp when the last (latest) backup copy was created for this backup item.

Optional parentName

parentName: undefined | string
member

{string} [parentName] Parent name of the DB such as Instance or Availability Group.

Optional parentType

parentType: undefined | string
member

{string} [parentType] Parent type of protected item, example: for a DB, standalone server or distributed

Optional policyId

policyId: undefined | string
member

{string} [policyId] ID of the backup policy with which this item is backed up.

Optional protectedItemDataSourceId

protectedItemDataSourceId: undefined | string
member

{string} [protectedItemDataSourceId] Data ID of the protected item.

Optional protectedItemHealthStatus

protectedItemHealthStatus: ProtectedItemHealthStatus
member

{ProtectedItemHealthStatus} [protectedItemHealthStatus] Health status of the backup item, evaluated based on last heartbeat received. Possible values include: 'Invalid', 'Healthy', 'Unhealthy', 'NotReachable', 'IRPending'

protectedItemType

protectedItemType: "AzureVmWorkloadSAPHanaDatabase"
member

{string} protectedItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionState
member

{ProtectionState} [protectionState] Backup state of this backup item. Possible values include: 'Invalid', 'IRPending', 'Protected', 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'

Optional protectionStatus

protectionStatus: undefined | string
member

{string} [protectionStatus] Backup status of this backup item.

serializedName

serializedName: string = "AzureVmWorkloadSAPHanaDatabase"

Optional serverName

serverName: undefined | string
member

{string} [serverName] Host/Cluster Name for instance or AG

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] ARM ID of the resource to be backed up.

Optional workloadType

workloadType: DataSourceType
member

{DataSourceType} [workloadType] Type of workload this item represents. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

type

type: object

className

className: string = "AzureVmWorkloadSAPHanaDatabaseProtectedItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectedItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectedItem"

modelProperties

modelProperties: object

Const AzureVmWorkloadSAPHanaDatabaseWorkloadItem

AzureVmWorkloadSAPHanaDatabaseWorkloadItem: object
interface

An interface representing AzureVmWorkloadSAPHanaDatabaseWorkloadItem. Azure VM workload-specific workload item representing SAP Hana Database.

Optional backupManagementType

backupManagementType: undefined | string
member

{string} [backupManagementType] Type of backup managemenent to backup an item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the backup item.

Optional isAutoProtectable

isAutoProtectable: undefined | false | true
member

{boolean} [isAutoProtectable] Indicates if workload item is auto-protectable

Optional parentName

parentName: undefined | string
member

{string} [parentName] Name for instance or AG

Optional protectionState

protectionState: ProtectionStatus
member

{ProtectionStatus} [protectionState] State of the back up item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "SAPHanaDatabase"

Optional serverName

serverName: undefined | string
member

{string} [serverName] Host/Cluster Name for instance or AG

Optional subWorkloadItemCount

subWorkloadItemCount: undefined | number
member

{number} [subWorkloadItemCount] For instance or AG, indicates number of DB's to be protected

Optional subinquireditemcount

subinquireditemcount: undefined | number
member

{number} [subinquireditemcount] For instance or AG, indicates number of DB's present

workloadItemType

workloadItemType: "SAPHanaDatabase"
member

{string} workloadItemType Polymorphic Discriminator

Optional workloadType

workloadType: undefined | string
member

{string} [workloadType] Type of workload for the backup management

type

type: object

className

className: string = "AzureVmWorkloadSAPHanaDatabaseWorkloadItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = WorkloadItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "WorkloadItem"

modelProperties

modelProperties: object

Const AzureVmWorkloadSAPHanaSystemProtectableItem

AzureVmWorkloadSAPHanaSystemProtectableItem: object
interface

An interface representing AzureVmWorkloadSAPHanaSystemProtectableItem. Azure VM workload-specific protectable item representing SAP Hana System.

Optional backupManagementType

backupManagementType: undefined | string
member

{string} [backupManagementType] Type of backup managemenent to backup an item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the backup item.

Optional isAutoProtectable

isAutoProtectable: undefined | false | true
member

{boolean} [isAutoProtectable] Indicates if protectable item is auto-protectable

Optional isAutoProtected

isAutoProtected: undefined | false | true
member

{boolean} [isAutoProtected] Indicates if protectable item is auto-protected

Optional parentName

parentName: undefined | string
member

{string} [parentName] Name for instance or AG

Optional parentUniqueName

parentUniqueName: undefined | string
member

{string} [parentUniqueName] Parent Unique Name is added to provide the service formatted URI Name of the Parent Only Applicable for data bases where the parent would be either Instance or a SQL AG.

Optional prebackupvalidation

prebackupvalidation: PreBackupValidation
member

{PreBackupValidation} [prebackupvalidation] Pre-backup validation for protectable objects

protectableItemType

protectableItemType: "SAPHanaSystem"
member

{string} protectableItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionStatus
member

{ProtectionStatus} [protectionState] State of the back up item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "SAPHanaSystem"

Optional serverName

serverName: undefined | string
member

{string} [serverName] Host/Cluster Name for instance or AG

Optional subinquireditemcount

subinquireditemcount: undefined | number
member

{number} [subinquireditemcount] For instance or AG, indicates number of DB's present

Optional subprotectableitemcount

subprotectableitemcount: undefined | number
member

{number} [subprotectableitemcount] For instance or AG, indicates number of DB's to be protected

Optional workloadType

workloadType: undefined | string
member

{string} [workloadType] Type of workload for the backup management

type

type: object

className

className: string = "AzureVmWorkloadSAPHanaSystemProtectableItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = WorkloadProtectableItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "WorkloadProtectableItem"

modelProperties

modelProperties: object

Const AzureVmWorkloadSAPHanaSystemWorkloadItem

AzureVmWorkloadSAPHanaSystemWorkloadItem: object
interface

An interface representing AzureVmWorkloadSAPHanaSystemWorkloadItem. Azure VM workload-specific workload item representing SAP Hana System.

Optional backupManagementType

backupManagementType: undefined | string
member

{string} [backupManagementType] Type of backup managemenent to backup an item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the backup item.

Optional isAutoProtectable

isAutoProtectable: undefined | false | true
member

{boolean} [isAutoProtectable] Indicates if workload item is auto-protectable

Optional parentName

parentName: undefined | string
member

{string} [parentName] Name for instance or AG

Optional protectionState

protectionState: ProtectionStatus
member

{ProtectionStatus} [protectionState] State of the back up item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "SAPHanaSystem"

Optional serverName

serverName: undefined | string
member

{string} [serverName] Host/Cluster Name for instance or AG

Optional subWorkloadItemCount

subWorkloadItemCount: undefined | number
member

{number} [subWorkloadItemCount] For instance or AG, indicates number of DB's to be protected

Optional subinquireditemcount

subinquireditemcount: undefined | number
member

{number} [subinquireditemcount] For instance or AG, indicates number of DB's present

workloadItemType

workloadItemType: "SAPHanaSystem"
member

{string} workloadItemType Polymorphic Discriminator

Optional workloadType

workloadType: undefined | string
member

{string} [workloadType] Type of workload for the backup management

type

type: object

className

className: string = "AzureVmWorkloadSAPHanaSystemWorkloadItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = WorkloadItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "WorkloadItem"

modelProperties

modelProperties: object

Const AzureVmWorkloadSQLAvailabilityGroupProtectableItem

AzureVmWorkloadSQLAvailabilityGroupProtectableItem: object
interface

An interface representing AzureVmWorkloadSQLAvailabilityGroupProtectableItem. Azure VM workload-specific protectable item representing SQL Availability Group.

Optional backupManagementType

backupManagementType: undefined | string
member

{string} [backupManagementType] Type of backup managemenent to backup an item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the backup item.

Optional isAutoProtectable

isAutoProtectable: undefined | false | true
member

{boolean} [isAutoProtectable] Indicates if protectable item is auto-protectable

Optional isAutoProtected

isAutoProtected: undefined | false | true
member

{boolean} [isAutoProtected] Indicates if protectable item is auto-protected

Optional parentName

parentName: undefined | string
member

{string} [parentName] Name for instance or AG

Optional parentUniqueName

parentUniqueName: undefined | string
member

{string} [parentUniqueName] Parent Unique Name is added to provide the service formatted URI Name of the Parent Only Applicable for data bases where the parent would be either Instance or a SQL AG.

Optional prebackupvalidation

prebackupvalidation: PreBackupValidation
member

{PreBackupValidation} [prebackupvalidation] Pre-backup validation for protectable objects

protectableItemType

protectableItemType: "SQLAvailabilityGroupContainer"
member

{string} protectableItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionStatus
member

{ProtectionStatus} [protectionState] State of the back up item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "SQLAvailabilityGroupContainer"

Optional serverName

serverName: undefined | string
member

{string} [serverName] Host/Cluster Name for instance or AG

Optional subinquireditemcount

subinquireditemcount: undefined | number
member

{number} [subinquireditemcount] For instance or AG, indicates number of DB's present

Optional subprotectableitemcount

subprotectableitemcount: undefined | number
member

{number} [subprotectableitemcount] For instance or AG, indicates number of DB's to be protected

Optional workloadType

workloadType: undefined | string
member

{string} [workloadType] Type of workload for the backup management

type

type: object

className

className: string = "AzureVmWorkloadSQLAvailabilityGroupProtectableItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = WorkloadProtectableItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "WorkloadProtectableItem"

modelProperties

modelProperties: object

Const AzureVmWorkloadSQLDatabaseProtectableItem

AzureVmWorkloadSQLDatabaseProtectableItem: object
interface

An interface representing AzureVmWorkloadSQLDatabaseProtectableItem. Azure VM workload-specific protectable item representing SQL Database.

Optional backupManagementType

backupManagementType: undefined | string
member

{string} [backupManagementType] Type of backup managemenent to backup an item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the backup item.

Optional isAutoProtectable

isAutoProtectable: undefined | false | true
member

{boolean} [isAutoProtectable] Indicates if protectable item is auto-protectable

Optional isAutoProtected

isAutoProtected: undefined | false | true
member

{boolean} [isAutoProtected] Indicates if protectable item is auto-protected

Optional parentName

parentName: undefined | string
member

{string} [parentName] Name for instance or AG

Optional parentUniqueName

parentUniqueName: undefined | string
member

{string} [parentUniqueName] Parent Unique Name is added to provide the service formatted URI Name of the Parent Only Applicable for data bases where the parent would be either Instance or a SQL AG.

Optional prebackupvalidation

prebackupvalidation: PreBackupValidation
member

{PreBackupValidation} [prebackupvalidation] Pre-backup validation for protectable objects

protectableItemType

protectableItemType: "SQLDataBase"
member

{string} protectableItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionStatus
member

{ProtectionStatus} [protectionState] State of the back up item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "SQLDataBase"

Optional serverName

serverName: undefined | string
member

{string} [serverName] Host/Cluster Name for instance or AG

Optional subinquireditemcount

subinquireditemcount: undefined | number
member

{number} [subinquireditemcount] For instance or AG, indicates number of DB's present

Optional subprotectableitemcount

subprotectableitemcount: undefined | number
member

{number} [subprotectableitemcount] For instance or AG, indicates number of DB's to be protected

Optional workloadType

workloadType: undefined | string
member

{string} [workloadType] Type of workload for the backup management

type

type: object

className

className: string = "AzureVmWorkloadSQLDatabaseProtectableItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = WorkloadProtectableItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "WorkloadProtectableItem"

modelProperties

modelProperties: object

Const AzureVmWorkloadSQLDatabaseProtectedItem

AzureVmWorkloadSQLDatabaseProtectedItem: object
interface

An interface representing AzureVmWorkloadSQLDatabaseProtectedItem. Azure VM workload-specific protected item representing SQL Database.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional backupSetName

backupSetName: undefined | string
member

{string} [backupSetName] Name of the backup set the backup item belongs to

Optional containerName

containerName: undefined | string
member

{string} [containerName] Unique name of container

Optional createMode

createMode: CreateMode
member

{CreateMode} [createMode] Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: 'Invalid', 'Default', 'Recover'

Optional extendedInfo

extendedInfo: AzureVmWorkloadProtectedItemExtendedInfo
member

{AzureVmWorkloadProtectedItemExtendedInfo} [extendedInfo] Additional information for this backup item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the DB represented by this backup item.

Optional lastBackupErrorDetail

lastBackupErrorDetail: ErrorDetail
member

{ErrorDetail} [lastBackupErrorDetail] Error details in last backup

Optional lastBackupStatus

lastBackupStatus: LastBackupStatus
member

{LastBackupStatus} [lastBackupStatus] Last backup operation status. Possible values: Healthy, Unhealthy. Possible values include: 'Invalid', 'Healthy', 'Unhealthy', 'IRPending'

Optional lastBackupTime

lastBackupTime: Date
member

{Date} [lastBackupTime] Timestamp of the last backup operation on this backup item.

Optional lastRecoveryPoint

lastRecoveryPoint: Date
member

{Date} [lastRecoveryPoint] Timestamp when the last (latest) backup copy was created for this backup item.

Optional parentName

parentName: undefined | string
member

{string} [parentName] Parent name of the DB such as Instance or Availability Group.

Optional parentType

parentType: undefined | string
member

{string} [parentType] Parent type of DB, SQLAG or StandAlone

Optional policyId

policyId: undefined | string
member

{string} [policyId] ID of the backup policy with which this item is backed up.

Optional protectedItemDataSourceId

protectedItemDataSourceId: undefined | string
member

{string} [protectedItemDataSourceId] Data ID of the protected item.

Optional protectedItemHealthStatus

protectedItemHealthStatus: ProtectedItemHealthStatus
member

{ProtectedItemHealthStatus} [protectedItemHealthStatus] Health status of the backup item, evaluated based on last heartbeat received. Possible values include: 'Invalid', 'Healthy', 'Unhealthy', 'NotReachable', 'IRPending'

protectedItemType

protectedItemType: "AzureVmWorkloadSQLDatabase"
member

{string} protectedItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionState
member

{ProtectionState} [protectionState] Backup state of this backup item. Possible values include: 'Invalid', 'IRPending', 'Protected', 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'

Optional protectionStatus

protectionStatus: undefined | string
member

{string} [protectionStatus] Backup status of this backup item.

serializedName

serializedName: string = "AzureVmWorkloadSQLDatabase"

Optional serverName

serverName: undefined | string
member

{string} [serverName] Host/Cluster Name for instance or AG

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] ARM ID of the resource to be backed up.

Optional workloadType

workloadType: DataSourceType
member

{DataSourceType} [workloadType] Type of workload this item represents. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

type

type: object

className

className: string = "AzureVmWorkloadSQLDatabaseProtectedItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectedItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectedItem"

modelProperties

modelProperties: object

extendedInfo

extendedInfo: object

serializedName

serializedName: string = "extendedInfo"

type

type: object

className

className: string = "AzureVmWorkloadProtectedItemExtendedInfo"

name

name: "Composite" = "Composite"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

lastBackupErrorDetail

lastBackupErrorDetail: object

serializedName

serializedName: string = "lastBackupErrorDetail"

type

type: object

className

className: string = "ErrorDetail"

name

name: "Composite" = "Composite"

lastBackupStatus

lastBackupStatus: object

serializedName

serializedName: string = "lastBackupStatus"

type

type: object

name

name: "String" = "String"

lastBackupTime

lastBackupTime: object

serializedName

serializedName: string = "lastBackupTime"

type

type: object

name

name: "DateTime" = "DateTime"

parentName

parentName: object

serializedName

serializedName: string = "parentName"

type

type: object

name

name: "String" = "String"

parentType

parentType: object

serializedName

serializedName: string = "parentType"

type

type: object

name

name: "String" = "String"

protectedItemDataSourceId

protectedItemDataSourceId: object

serializedName

serializedName: string = "protectedItemDataSourceId"

type

type: object

name

name: "String" = "String"

protectedItemHealthStatus

protectedItemHealthStatus: object

serializedName

serializedName: string = "protectedItemHealthStatus"

type

type: object

name

name: "String" = "String"

protectionState

protectionState: object

serializedName

serializedName: string = "protectionState"

type

type: object

name

name: "String" = "String"

protectionStatus

protectionStatus: object

serializedName

serializedName: string = "protectionStatus"

type

type: object

name

name: "String" = "String"

serverName

serverName: object

serializedName

serializedName: string = "serverName"

type

type: object

name

name: "String" = "String"

Const AzureVmWorkloadSQLDatabaseWorkloadItem

AzureVmWorkloadSQLDatabaseWorkloadItem: object
interface

An interface representing AzureVmWorkloadSQLDatabaseWorkloadItem. Azure VM workload-specific workload item representing SQL Database.

Optional backupManagementType

backupManagementType: undefined | string
member

{string} [backupManagementType] Type of backup managemenent to backup an item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the backup item.

Optional isAutoProtectable

isAutoProtectable: undefined | false | true
member

{boolean} [isAutoProtectable] Indicates if workload item is auto-protectable

Optional parentName

parentName: undefined | string
member

{string} [parentName] Name for instance or AG

Optional protectionState

protectionState: ProtectionStatus
member

{ProtectionStatus} [protectionState] State of the back up item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "SQLDataBase"

Optional serverName

serverName: undefined | string
member

{string} [serverName] Host/Cluster Name for instance or AG

Optional subWorkloadItemCount

subWorkloadItemCount: undefined | number
member

{number} [subWorkloadItemCount] For instance or AG, indicates number of DB's to be protected

Optional subinquireditemcount

subinquireditemcount: undefined | number
member

{number} [subinquireditemcount] For instance or AG, indicates number of DB's present

workloadItemType

workloadItemType: "SQLDataBase"
member

{string} workloadItemType Polymorphic Discriminator

Optional workloadType

workloadType: undefined | string
member

{string} [workloadType] Type of workload for the backup management

type

type: object

className

className: string = "AzureVmWorkloadSQLDatabaseWorkloadItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = WorkloadItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "WorkloadItem"

modelProperties

modelProperties: object

Const AzureVmWorkloadSQLInstanceProtectableItem

AzureVmWorkloadSQLInstanceProtectableItem: object
interface

An interface representing AzureVmWorkloadSQLInstanceProtectableItem. Azure VM workload-specific protectable item representing SQL Instance.

Optional backupManagementType

backupManagementType: undefined | string
member

{string} [backupManagementType] Type of backup managemenent to backup an item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the backup item.

Optional isAutoProtectable

isAutoProtectable: undefined | false | true
member

{boolean} [isAutoProtectable] Indicates if protectable item is auto-protectable

Optional isAutoProtected

isAutoProtected: undefined | false | true
member

{boolean} [isAutoProtected] Indicates if protectable item is auto-protected

Optional parentName

parentName: undefined | string
member

{string} [parentName] Name for instance or AG

Optional parentUniqueName

parentUniqueName: undefined | string
member

{string} [parentUniqueName] Parent Unique Name is added to provide the service formatted URI Name of the Parent Only Applicable for data bases where the parent would be either Instance or a SQL AG.

Optional prebackupvalidation

prebackupvalidation: PreBackupValidation
member

{PreBackupValidation} [prebackupvalidation] Pre-backup validation for protectable objects

protectableItemType

protectableItemType: "SQLInstance"
member

{string} protectableItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionStatus
member

{ProtectionStatus} [protectionState] State of the back up item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "SQLInstance"

Optional serverName

serverName: undefined | string
member

{string} [serverName] Host/Cluster Name for instance or AG

Optional subinquireditemcount

subinquireditemcount: undefined | number
member

{number} [subinquireditemcount] For instance or AG, indicates number of DB's present

Optional subprotectableitemcount

subprotectableitemcount: undefined | number
member

{number} [subprotectableitemcount] For instance or AG, indicates number of DB's to be protected

Optional workloadType

workloadType: undefined | string
member

{string} [workloadType] Type of workload for the backup management

type

type: object

className

className: string = "AzureVmWorkloadSQLInstanceProtectableItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = WorkloadProtectableItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "WorkloadProtectableItem"

modelProperties

modelProperties: object

Const AzureVmWorkloadSQLInstanceWorkloadItem

AzureVmWorkloadSQLInstanceWorkloadItem: object
interface

An interface representing AzureVmWorkloadSQLInstanceWorkloadItem. Azure VM workload-specific workload item representing SQL Instance.

Optional backupManagementType

backupManagementType: undefined | string
member

{string} [backupManagementType] Type of backup managemenent to backup an item.

Optional dataDirectoryPaths

dataDirectoryPaths: SQLDataDirectory[]
member

{SQLDataDirectory[]} [dataDirectoryPaths] Data Directory Paths for default directories

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the backup item.

Optional isAutoProtectable

isAutoProtectable: undefined | false | true
member

{boolean} [isAutoProtectable] Indicates if workload item is auto-protectable

Optional parentName

parentName: undefined | string
member

{string} [parentName] Name for instance or AG

Optional protectionState

protectionState: ProtectionStatus
member

{ProtectionStatus} [protectionState] State of the back up item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "SQLInstance"

Optional serverName

serverName: undefined | string
member

{string} [serverName] Host/Cluster Name for instance or AG

Optional subWorkloadItemCount

subWorkloadItemCount: undefined | number
member

{number} [subWorkloadItemCount] For instance or AG, indicates number of DB's to be protected

Optional subinquireditemcount

subinquireditemcount: undefined | number
member

{number} [subinquireditemcount] For instance or AG, indicates number of DB's present

workloadItemType

workloadItemType: "SQLInstance"
member

{string} workloadItemType Polymorphic Discriminator

Optional workloadType

workloadType: undefined | string
member

{string} [workloadType] Type of workload for the backup management

type

type: object

className

className: string = "AzureVmWorkloadSQLInstanceWorkloadItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = WorkloadItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "WorkloadItem"

modelProperties

modelProperties: object

dataDirectoryPaths

dataDirectoryPaths: object

serializedName

serializedName: string = "dataDirectoryPaths"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SQLDataDirectory"

name

name: "Composite" = "Composite"

Const AzureWorkloadAutoProtectionIntent

AzureWorkloadAutoProtectionIntent: object
interface

An interface representing AzureWorkloadAutoProtectionIntent. Azure Recovery Services Vault specific protection intent item.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional itemId

itemId: undefined | string
member

{string} [itemId] ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId

Optional policyId

policyId: undefined | string
member

{string} [policyId] ID of the backup policy with which this item is backed up.

protectionIntentItemType

protectionIntentItemType: "AzureWorkloadAutoProtectionIntent"
member

{string} protectionIntentItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionStatus
member

{ProtectionStatus} [protectionState] Backup state of this backup item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "AzureWorkloadAutoProtectionIntent"

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] ARM ID of the resource to be backed up.

type

type: object

className

className: string = "AzureWorkloadAutoProtectionIntent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionIntent.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionIntent"

modelProperties

modelProperties: object

Const AzureWorkloadBackupRequest

AzureWorkloadBackupRequest: object
interface

An interface representing AzureWorkloadBackupRequest. AzureWorkload workload-specific backup request.

Optional backupType

backupType: BackupType
member

{BackupType} [backupType] Type of backup, viz. Full, Differential, Log or CopyOnlyFull. Possible values include: 'Invalid', 'Full', 'Differential', 'Log', 'CopyOnlyFull'

Optional enableCompression

enableCompression: undefined | false | true
member

{boolean} [enableCompression] Bool for Compression setting

objectType

objectType: "AzureWorkloadBackupRequest"
member

{string} objectType Polymorphic Discriminator

Optional recoveryPointExpiryTimeInUTC

recoveryPointExpiryTimeInUTC: Date
member

{Date} [recoveryPointExpiryTimeInUTC] Backup copy will expire after the time specified (UTC).

serializedName

serializedName: string = "AzureWorkloadBackupRequest"

type

type: object

className

className: string = "AzureWorkloadBackupRequest"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = BackupRequest.type.polymorphicDiscriminator

uberParent

uberParent: string = "BackupRequest"

modelProperties

modelProperties: object

backupType

backupType: object

serializedName

serializedName: string = "backupType"

type

type: object

name

name: "String" = "String"

enableCompression

enableCompression: object

serializedName

serializedName: string = "enableCompression"

type

type: object

name

name: "Boolean" = "Boolean"

recoveryPointExpiryTimeInUTC

recoveryPointExpiryTimeInUTC: object

serializedName

serializedName: string = "recoveryPointExpiryTimeInUTC"

type

type: object

name

name: "DateTime" = "DateTime"

Const AzureWorkloadContainer

AzureWorkloadContainer: object
interface

An interface representing AzureWorkloadContainer. Container for the workloads running inside Azure Compute or Classic Compute.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

containerType

containerType: "AzureWorkloadBackupRequest"
member

{string} containerType Polymorphic Discriminator

Optional extendedInfo

extendedInfo: AzureWorkloadContainerExtendedInfo
member

{AzureWorkloadContainerExtendedInfo} [extendedInfo] Additional details of a workload container.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the container.

Optional healthStatus

healthStatus: undefined | string
member

{string} [healthStatus] Status of health of the container.

Optional lastUpdatedTime

lastUpdatedTime: Date
member

{Date} [lastUpdatedTime] Time stamp when this container was updated.

Optional registrationStatus

registrationStatus: undefined | string
member

{string} [registrationStatus] Status of registration of the container with the Recovery Services Vault.

serializedName

serializedName: string = "AzureWorkloadBackupRequest"

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] ARM ID of the virtual machine represented by this Azure Workload Container

Optional workloadType

workloadType: WorkloadType
member

{WorkloadType} [workloadType] Workload type for which registration was sent. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

type

type: object

className

className: string = "AzureWorkloadContainer"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionContainer.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionContainer"

modelProperties

modelProperties: object

extendedInfo

extendedInfo: object

serializedName

serializedName: string = "extendedInfo"

type

type: object

className

className: string = "AzureWorkloadContainerExtendedInfo"

name

name: "Composite" = "Composite"

lastUpdatedTime

lastUpdatedTime: object

serializedName

serializedName: string = "lastUpdatedTime"

type

type: object

name

name: "DateTime" = "DateTime"

sourceResourceId

sourceResourceId: object

serializedName

serializedName: string = "sourceResourceId"

type

type: object

name

name: "String" = "String"

workloadType

workloadType: object

serializedName

serializedName: string = "workloadType"

type

type: object

name

name: "String" = "String"

Const AzureWorkloadContainerExtendedInfo

AzureWorkloadContainerExtendedInfo: object
interface

An interface representing AzureWorkloadContainerExtendedInfo. Extended information of the container.

Optional hostServerName

hostServerName: undefined | string
member

{string} [hostServerName] Host Os Name in case of Stand Alone and Cluster Name in case of distributed container.

Optional inquiryInfo

inquiryInfo: InquiryInfo
member

{InquiryInfo} [inquiryInfo] Inquiry Status for the container.

Optional nodesList

nodesList: DistributedNodesInfo[]
member

{DistributedNodesInfo[]} [nodesList] List of the nodes in case of distributed container.

serializedName

serializedName: string = "AzureWorkloadContainerExtendedInfo"

type

type: object

className

className: string = "AzureWorkloadContainerExtendedInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

hostServerName

hostServerName: object

serializedName

serializedName: string = "hostServerName"

type

type: object

name

name: "String" = "String"

inquiryInfo

inquiryInfo: object

serializedName

serializedName: string = "inquiryInfo"

type

type: object

className

className: string = "InquiryInfo"

name

name: "Composite" = "Composite"

nodesList

nodesList: object

serializedName

serializedName: string = "nodesList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DistributedNodesInfo"

name

name: "Composite" = "Composite"

Const AzureWorkloadErrorInfo

AzureWorkloadErrorInfo: object
interface

An interface representing AzureWorkloadErrorInfo. Azure storage specific error information

Optional additionalDetails

additionalDetails: undefined | string
member

{string} [additionalDetails] Additional details for above error code.

Optional errorCode

errorCode: undefined | number
member

{number} [errorCode] Error code.

Optional errorString

errorString: undefined | string
member

{string} [errorString] Localized error string.

Optional errorTitle

errorTitle: undefined | string
member

{string} [errorTitle] Title: Typically, the entity that the error pertains to.

Optional recommendations

recommendations: string[]
member

{string[]} [recommendations] List of localized recommendations for above error code.

serializedName

serializedName: string = "AzureWorkloadErrorInfo"

type

type: object

className

className: string = "AzureWorkloadErrorInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

additionalDetails

additionalDetails: object

serializedName

serializedName: string = "additionalDetails"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "errorCode"

type

type: object

name

name: "Number" = "Number"

errorString

errorString: object

serializedName

serializedName: string = "errorString"

type

type: object

name

name: "String" = "String"

errorTitle

errorTitle: object

serializedName

serializedName: string = "errorTitle"

type

type: object

name

name: "String" = "String"

recommendations

recommendations: object

serializedName

serializedName: string = "recommendations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const AzureWorkloadJob

AzureWorkloadJob: object
interface

An interface representing AzureWorkloadJob. Azure storage specific job.

Optional actionsInfo

actionsInfo: JobSupportedAction[]
member

{JobSupportedAction[]} [actionsInfo] Gets or sets the state/actions applicable on this job like cancel/retry.

Optional activityId

activityId: undefined | string
member

{string} [activityId] ActivityId of job.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Backup management type to execute the current job. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional duration

duration: undefined | string
member

{string} [duration] Time elapsed during the execution of this job.

Optional endTime

endTime: Date
member

{Date} [endTime] The end time.

Optional entityFriendlyName

entityFriendlyName: undefined | string
member

{string} [entityFriendlyName] Friendly name of the entity on which the current job is executing.

Optional errorDetails

errorDetails: AzureWorkloadErrorInfo[]
member

{AzureWorkloadErrorInfo[]} [errorDetails] Error details on execution of this job.

Optional extendedInfo

extendedInfo: AzureWorkloadJobExtendedInfo
member

{AzureWorkloadJobExtendedInfo} [extendedInfo] Additional information about the job.

jobType

jobType: "AzureWorkloadJob"
member

{string} jobType Polymorphic Discriminator

Optional operation

operation: undefined | string
member

{string} [operation] The operation name.

serializedName

serializedName: string = "AzureWorkloadJob"

Optional startTime

startTime: Date
member

{Date} [startTime] The start time.

Optional status

status: undefined | string
member

{string} [status] Job status.

Optional workloadType

workloadType: undefined | string
member

{string} [workloadType] Workload type of the job

type

type: object

className

className: string = "AzureWorkloadJob"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Job.type.polymorphicDiscriminator

uberParent

uberParent: string = "Job"

modelProperties

modelProperties: object

actionsInfo

actionsInfo: object

serializedName

serializedName: string = "actionsInfo"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["Invalid","Cancellable","Retriable"]

name

name: "Enum" = "Enum"

duration

duration: object

serializedName

serializedName: string = "duration"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

errorDetails

errorDetails: object

serializedName

serializedName: string = "errorDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureWorkloadErrorInfo"

name

name: "Composite" = "Composite"

extendedInfo

extendedInfo: object

serializedName

serializedName: string = "extendedInfo"

type

type: object

className

className: string = "AzureWorkloadJobExtendedInfo"

name

name: "Composite" = "Composite"

workloadType

workloadType: object

serializedName

serializedName: string = "workloadType"

type

type: object

name

name: "String" = "String"

Const AzureWorkloadJobExtendedInfo

AzureWorkloadJobExtendedInfo: object
interface

An interface representing AzureWorkloadJobExtendedInfo. Azure VM workload-specific additional information for job.

Optional dynamicErrorMessage

dynamicErrorMessage: undefined | string
member

{string} [dynamicErrorMessage] Non localized error message on job execution.

Optional propertyBag

propertyBag: undefined | object
member

{{ [propertyName: string]: string }} [propertyBag] Job properties.

serializedName

serializedName: string = "AzureWorkloadJobExtendedInfo"

Optional tasksList

tasksList: AzureWorkloadJobTaskDetails[]
member

{AzureWorkloadJobTaskDetails[]} [tasksList] List of tasks for this job

type

type: object

className

className: string = "AzureWorkloadJobExtendedInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dynamicErrorMessage

dynamicErrorMessage: object

serializedName

serializedName: string = "dynamicErrorMessage"

type

type: object

name

name: "String" = "String"

propertyBag

propertyBag: object

serializedName

serializedName: string = "propertyBag"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

tasksList

tasksList: object

serializedName

serializedName: string = "tasksList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureWorkloadJobTaskDetails"

name

name: "Composite" = "Composite"

Const AzureWorkloadJobTaskDetails

AzureWorkloadJobTaskDetails: object
interface

An interface representing AzureWorkloadJobTaskDetails. Azure VM workload specific job task details.

serializedName

serializedName: string = "AzureWorkloadJobTaskDetails"

Optional status

status: undefined | string
member

{string} [status] The status.

Optional taskId

taskId: undefined | string
member

{string} [taskId] The task display name.

type

type: object

className

className: string = "AzureWorkloadJobTaskDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

taskId

taskId: object

serializedName

serializedName: string = "taskId"

type

type: object

name

name: "String" = "String"

Const AzureWorkloadRecoveryPoint

AzureWorkloadRecoveryPoint: object
interface

An interface representing AzureWorkloadRecoveryPoint. Workload specific recoverypoint, specifcally encaspulates full/diff recoverypoint

objectType

objectType: "AzureWorkloadRecoveryPoint"
member

{string} objectType Polymorphic Discriminator

Optional recoveryPointTimeInUTC

recoveryPointTimeInUTC: Date
member

{Date} [recoveryPointTimeInUTC] UTC time at which recoverypoint was created

serializedName

serializedName: string = "AzureWorkloadRecoveryPoint"

type

type: object
member

{RestorePointType} [type] Type of restore point. Possible values include: 'Invalid', 'Full', 'Log', 'Differential'

className

className: string = "AzureWorkloadRecoveryPoint"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RecoveryPoint.type.polymorphicDiscriminator

uberParent

uberParent: string = "RecoveryPoint"

modelProperties

modelProperties: object

recoveryPointTimeInUTC

recoveryPointTimeInUTC: object

serializedName

serializedName: string = "recoveryPointTimeInUTC"

type

type: object

name

name: "DateTime" = "DateTime"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const AzureWorkloadRestoreRequest

AzureWorkloadRestoreRequest: object
interface

An interface representing AzureWorkloadRestoreRequest. AzureWorkload-specific restore.

objectType

objectType: "AzureWorkloadRestoreRequest"
member

{string} objectType Polymorphic Discriminator

Optional propertyBag

propertyBag: undefined | object
member

{{ [propertyName: string]: string }} [propertyBag] Workload specific property bag.

Optional recoveryType

recoveryType: RecoveryType
member

{RecoveryType} [recoveryType] OLR/ALR, RestoreDisks is invalid option. Possible values include: 'Invalid', 'OriginalLocation', 'AlternateLocation', 'RestoreDisks'

serializedName

serializedName: string = "AzureWorkloadRestoreRequest"

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] Fully qualified ARM ID of the VM on which workload that was running is being recovered.

type

type: object

className

className: string = "AzureWorkloadRestoreRequest"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RestoreRequest.type.polymorphicDiscriminator

uberParent

uberParent: string = "RestoreRequest"

modelProperties

modelProperties: object

propertyBag

propertyBag: object

serializedName

serializedName: string = "propertyBag"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

recoveryType

recoveryType: object

serializedName

serializedName: string = "recoveryType"

type

type: object

name

name: "String" = "String"

sourceResourceId

sourceResourceId: object

serializedName

serializedName: string = "sourceResourceId"

type

type: object

name

name: "String" = "String"

Const AzureWorkloadSAPHanaPointInTimeRecoveryPoint

AzureWorkloadSAPHanaPointInTimeRecoveryPoint: object
interface

An interface representing AzureWorkloadSAPHanaPointInTimeRecoveryPoint. Recovery point specific to PointInTime in SAPHana

objectType

objectType: "AzureWorkloadSAPHanaPointInTimeRecoveryPoint"
member

{string} objectType Polymorphic Discriminator

Optional recoveryPointTimeInUTC

recoveryPointTimeInUTC: Date
member

{Date} [recoveryPointTimeInUTC] UTC time at which recoverypoint was created

serializedName

serializedName: string = "AzureWorkloadSAPHanaPointInTimeRecoveryPoint"

Optional timeRanges

timeRanges: PointInTimeRange[]
member

{PointInTimeRange[]} [timeRanges] List of log ranges

type

type: object
member

{RestorePointType} [type] Type of restore point. Possible values include: 'Invalid', 'Full', 'Log', 'Differential'

className

className: string = "AzureWorkloadSAPHanaPointInTimeRecoveryPoint"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RecoveryPoint.type.polymorphicDiscriminator

uberParent

uberParent: string = "RecoveryPoint"

modelProperties

modelProperties: object

timeRanges

timeRanges: object

serializedName

serializedName: string = "timeRanges"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PointInTimeRange"

name

name: "Composite" = "Composite"

Const AzureWorkloadSAPHanaPointInTimeRestoreRequest

AzureWorkloadSAPHanaPointInTimeRestoreRequest: object
interface

An interface representing AzureWorkloadSAPHanaPointInTimeRestoreRequest. AzureWorkload SAP Hana -specific restore. Specifically for PointInTime/Log restore

objectType

objectType: "AzureWorkloadSAPHanaPointInTimeRestoreRequest"
member

{string} objectType Polymorphic Discriminator

Optional pointInTime

pointInTime: Date
member

{Date} [pointInTime] PointInTime value

Optional propertyBag

propertyBag: undefined | object
member

{{ [propertyName: string]: string }} [propertyBag] Workload specific property bag.

Optional recoveryType

recoveryType: RecoveryType
member

{RecoveryType} [recoveryType] OLR/ALR, RestoreDisks is invalid option. Possible values include: 'Invalid', 'OriginalLocation', 'AlternateLocation', 'RestoreDisks'

serializedName

serializedName: string = "AzureWorkloadSAPHanaPointInTimeRestoreRequest"

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] Fully qualified ARM ID of the VM on which workload that was running is being recovered.

Optional targetInfo

targetInfo: TargetRestoreInfo
member

{TargetRestoreInfo} [targetInfo] Details of target database

type

type: object

className

className: string = "AzureWorkloadSAPHanaPointInTimeRestoreRequest"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RestoreRequest.type.polymorphicDiscriminator

uberParent

uberParent: string = "RestoreRequest"

modelProperties

modelProperties: object

pointInTime

pointInTime: object

serializedName

serializedName: string = "pointInTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const AzureWorkloadSAPHanaRecoveryPoint

AzureWorkloadSAPHanaRecoveryPoint: object
interface

An interface representing AzureWorkloadSAPHanaRecoveryPoint. SAPHana specific recoverypoint, specifcally encaspulates full/diff recoverypoints

objectType

objectType: "AzureWorkloadSAPHanaRecoveryPoint"
member

{string} objectType Polymorphic Discriminator

Optional recoveryPointTimeInUTC

recoveryPointTimeInUTC: Date
member

{Date} [recoveryPointTimeInUTC] UTC time at which recoverypoint was created

serializedName

serializedName: string = "AzureWorkloadSAPHanaRecoveryPoint"

type

type: object
member

{RestorePointType} [type] Type of restore point. Possible values include: 'Invalid', 'Full', 'Log', 'Differential'

className

className: string = "AzureWorkloadSAPHanaRecoveryPoint"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RecoveryPoint.type.polymorphicDiscriminator

uberParent

uberParent: string = "RecoveryPoint"

modelProperties

modelProperties: object

recoveryPointTimeInUTC

recoveryPointTimeInUTC: object

serializedName

serializedName: string = "recoveryPointTimeInUTC"

type

type: object

name

name: "DateTime" = "DateTime"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const AzureWorkloadSAPHanaRestoreRequest

AzureWorkloadSAPHanaRestoreRequest: object
interface

An interface representing AzureWorkloadSAPHanaRestoreRequest. AzureWorkload SAP Hana-specific restore.

objectType

objectType: "AzureWorkloadSAPHanaRestoreRequest"
member

{string} objectType Polymorphic Discriminator

Optional propertyBag

propertyBag: undefined | object
member

{{ [propertyName: string]: string }} [propertyBag] Workload specific property bag.

Optional recoveryType

recoveryType: RecoveryType
member

{RecoveryType} [recoveryType] OLR/ALR, RestoreDisks is invalid option. Possible values include: 'Invalid', 'OriginalLocation', 'AlternateLocation', 'RestoreDisks'

serializedName

serializedName: string = "AzureWorkloadSAPHanaRestoreRequest"

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] Fully qualified ARM ID of the VM on which workload that was running is being recovered.

Optional targetInfo

targetInfo: TargetRestoreInfo
member

{TargetRestoreInfo} [targetInfo] Details of target database

type

type: object

className

className: string = "AzureWorkloadSAPHanaRestoreRequest"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RestoreRequest.type.polymorphicDiscriminator

uberParent

uberParent: string = "RestoreRequest"

modelProperties

modelProperties: object

propertyBag

propertyBag: object

serializedName

serializedName: string = "propertyBag"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

recoveryType

recoveryType: object

serializedName

serializedName: string = "recoveryType"

type

type: object

name

name: "String" = "String"

sourceResourceId

sourceResourceId: object

serializedName

serializedName: string = "sourceResourceId"

type

type: object

name

name: "String" = "String"

targetInfo

targetInfo: object

serializedName

serializedName: string = "targetInfo"

type

type: object

className

className: string = "TargetRestoreInfo"

name

name: "Composite" = "Composite"

Const AzureWorkloadSQLAutoProtectionIntent

AzureWorkloadSQLAutoProtectionIntent: object
interface

An interface representing AzureWorkloadSQLAutoProtectionIntent. Azure Workload SQL Auto Protection intent item.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional itemId

itemId: undefined | string
member

{string} [itemId] ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId

Optional policyId

policyId: undefined | string
member

{string} [policyId] ID of the backup policy with which this item is backed up.

protectionIntentItemType

protectionIntentItemType: "AzureWorkloadSQLAutoProtectionIntent"
member

{string} protectionIntentItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionStatus
member

{ProtectionStatus} [protectionState] Backup state of this backup item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "AzureWorkloadSQLAutoProtectionIntent"

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] ARM ID of the resource to be backed up.

Optional workloadItemType

workloadItemType: WorkloadItemType
member

{WorkloadItemType} [workloadItemType] Workload item type of the item for which intent is to be set. Possible values include: 'Invalid', 'SQLInstance', 'SQLDataBase', 'SAPHanaSystem', 'SAPHanaDatabase'

type

type: object

className

className: string = "AzureWorkloadSQLAutoProtectionIntent"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionIntent.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionIntent"

modelProperties

modelProperties: object

workloadItemType

workloadItemType: object

serializedName

serializedName: string = "workloadItemType"

type

type: object

name

name: "String" = "String"

Const AzureWorkloadSQLPointInTimeRecoveryPoint

AzureWorkloadSQLPointInTimeRecoveryPoint: object
interface

An interface representing AzureWorkloadSQLPointInTimeRecoveryPoint. Recovery point specific to PointInTime

Optional extendedInfo

extendedInfo: AzureWorkloadSQLRecoveryPointExtendedInfo
member

{AzureWorkloadSQLRecoveryPointExtendedInfo} [extendedInfo] Extended Info that provides data directory details. Will be populated in two cases: When a specific recovery point is accessed using GetRecoveryPoint Or when ListRecoveryPoints is called for Log RP only with ExtendedInfo query filter

objectType

objectType: "AzureWorkloadSQLPointInTimeRecoveryPoint"
member

{string} objectType Polymorphic Discriminator

Optional recoveryPointTimeInUTC

recoveryPointTimeInUTC: Date
member

{Date} [recoveryPointTimeInUTC] UTC time at which recoverypoint was created

serializedName

serializedName: string = "AzureWorkloadSQLPointInTimeRecoveryPoint"

Optional timeRanges

timeRanges: PointInTimeRange[]
member

{PointInTimeRange[]} [timeRanges] List of log ranges

type

type: object
member

{RestorePointType} [type] Type of restore point. Possible values include: 'Invalid', 'Full', 'Log', 'Differential'

className

className: string = "AzureWorkloadSQLPointInTimeRecoveryPoint"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RecoveryPoint.type.polymorphicDiscriminator

uberParent

uberParent: string = "RecoveryPoint"

modelProperties

modelProperties: object

timeRanges

timeRanges: object

serializedName

serializedName: string = "timeRanges"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PointInTimeRange"

name

name: "Composite" = "Composite"

Const AzureWorkloadSQLPointInTimeRestoreRequest

AzureWorkloadSQLPointInTimeRestoreRequest: object
interface

An interface representing AzureWorkloadSQLPointInTimeRestoreRequest. AzureWorkload SQL -specific restore. Specifically for PointInTime/Log restore

Optional alternateDirectoryPaths

alternateDirectoryPaths: SQLDataDirectoryMapping[]
member

{SQLDataDirectoryMapping[]} [alternateDirectoryPaths] Data directory details

Optional isNonRecoverable

isNonRecoverable: undefined | false | true
member

{boolean} [isNonRecoverable] SQL specific property where user can chose to set no-recovery when restore operation is tried

objectType

objectType: "AzureWorkloadSQLPointInTimeRestoreRequest"
member

{string} objectType Polymorphic Discriminator

Optional pointInTime

pointInTime: Date
member

{Date} [pointInTime] PointInTime value

Optional propertyBag

propertyBag: undefined | object
member

{{ [propertyName: string]: string }} [propertyBag] Workload specific property bag.

Optional recoveryType

recoveryType: RecoveryType
member

{RecoveryType} [recoveryType] OLR/ALR, RestoreDisks is invalid option. Possible values include: 'Invalid', 'OriginalLocation', 'AlternateLocation', 'RestoreDisks'

serializedName

serializedName: string = "AzureWorkloadSQLPointInTimeRestoreRequest"

Optional shouldUseAlternateTargetLocation

shouldUseAlternateTargetLocation: undefined | false | true
member

{boolean} [shouldUseAlternateTargetLocation] Default option set to true. If this is set to false, alternate data directory must be provided

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] Fully qualified ARM ID of the VM on which workload that was running is being recovered.

Optional targetInfo

targetInfo: TargetRestoreInfo
member

{TargetRestoreInfo} [targetInfo] Details of target database

type

type: object

className

className: string = "AzureWorkloadSQLPointInTimeRestoreRequest"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RestoreRequest.type.polymorphicDiscriminator

uberParent

uberParent: string = "RestoreRequest"

modelProperties

modelProperties: object

pointInTime

pointInTime: object

serializedName

serializedName: string = "pointInTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const AzureWorkloadSQLRecoveryPoint

AzureWorkloadSQLRecoveryPoint: object
interface

An interface representing AzureWorkloadSQLRecoveryPoint. SQL specific recoverypoint, specifcally encaspulates full/diff recoverypoint alongwith extended info

Optional extendedInfo

extendedInfo: AzureWorkloadSQLRecoveryPointExtendedInfo
member

{AzureWorkloadSQLRecoveryPointExtendedInfo} [extendedInfo] Extended Info that provides data directory details. Will be populated in two cases: When a specific recovery point is accessed using GetRecoveryPoint Or when ListRecoveryPoints is called for Log RP only with ExtendedInfo query filter

objectType

objectType: "AzureWorkloadSQLRecoveryPoint"
member

{string} objectType Polymorphic Discriminator

Optional recoveryPointTimeInUTC

recoveryPointTimeInUTC: Date
member

{Date} [recoveryPointTimeInUTC] UTC time at which recoverypoint was created

serializedName

serializedName: string = "AzureWorkloadSQLRecoveryPoint"

type

type: object
member

{RestorePointType} [type] Type of restore point. Possible values include: 'Invalid', 'Full', 'Log', 'Differential'

className

className: string = "AzureWorkloadSQLRecoveryPoint"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RecoveryPoint.type.polymorphicDiscriminator

uberParent

uberParent: string = "RecoveryPoint"

modelProperties

modelProperties: object

extendedInfo

extendedInfo: object

serializedName

serializedName: string = "extendedInfo"

type

type: object

className

className: string = "AzureWorkloadSQLRecoveryPointExtendedInfo"

name

name: "Composite" = "Composite"

Const AzureWorkloadSQLRecoveryPointExtendedInfo

AzureWorkloadSQLRecoveryPointExtendedInfo: object
interface

An interface representing AzureWorkloadSQLRecoveryPointExtendedInfo. Extended info class details

Optional dataDirectoryPaths

dataDirectoryPaths: SQLDataDirectory[]
member

{SQLDataDirectory[]} [dataDirectoryPaths] List of data directory paths during restore operation.

Optional dataDirectoryTimeInUTC

dataDirectoryTimeInUTC: Date
member

{Date} [dataDirectoryTimeInUTC] UTC time at which data directory info was captured

serializedName

serializedName: string = "AzureWorkloadSQLRecoveryPointExtendedInfo"

type

type: object

className

className: string = "AzureWorkloadSQLRecoveryPointExtendedInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dataDirectoryPaths

dataDirectoryPaths: object

serializedName

serializedName: string = "dataDirectoryPaths"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SQLDataDirectory"

name

name: "Composite" = "Composite"

dataDirectoryTimeInUTC

dataDirectoryTimeInUTC: object

serializedName

serializedName: string = "dataDirectoryTimeInUTC"

type

type: object

name

name: "DateTime" = "DateTime"

Const AzureWorkloadSQLRestoreRequest

AzureWorkloadSQLRestoreRequest: object
interface

An interface representing AzureWorkloadSQLRestoreRequest. AzureWorkload SQL -specific restore. Specifically for full/diff restore

Optional alternateDirectoryPaths

alternateDirectoryPaths: SQLDataDirectoryMapping[]
member

{SQLDataDirectoryMapping[]} [alternateDirectoryPaths] Data directory details

Optional isNonRecoverable

isNonRecoverable: undefined | false | true
member

{boolean} [isNonRecoverable] SQL specific property where user can chose to set no-recovery when restore operation is tried

objectType

objectType: "AzureWorkloadSQLRestoreRequest"
member

{string} objectType Polymorphic Discriminator

Optional propertyBag

propertyBag: undefined | object
member

{{ [propertyName: string]: string }} [propertyBag] Workload specific property bag.

Optional recoveryType

recoveryType: RecoveryType
member

{RecoveryType} [recoveryType] OLR/ALR, RestoreDisks is invalid option. Possible values include: 'Invalid', 'OriginalLocation', 'AlternateLocation', 'RestoreDisks'

serializedName

serializedName: string = "AzureWorkloadSQLRestoreRequest"

Optional shouldUseAlternateTargetLocation

shouldUseAlternateTargetLocation: undefined | false | true
member

{boolean} [shouldUseAlternateTargetLocation] Default option set to true. If this is set to false, alternate data directory must be provided

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] Fully qualified ARM ID of the VM on which workload that was running is being recovered.

Optional targetInfo

targetInfo: TargetRestoreInfo
member

{TargetRestoreInfo} [targetInfo] Details of target database

type

type: object

className

className: string = "AzureWorkloadSQLRestoreRequest"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RestoreRequest.type.polymorphicDiscriminator

uberParent

uberParent: string = "RestoreRequest"

modelProperties

modelProperties: object

alternateDirectoryPaths

alternateDirectoryPaths: object

serializedName

serializedName: string = "alternateDirectoryPaths"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SQLDataDirectoryMapping"

name

name: "Composite" = "Composite"

isNonRecoverable

isNonRecoverable: object

serializedName

serializedName: string = "isNonRecoverable"

type

type: object

name

name: "Boolean" = "Boolean"

shouldUseAlternateTargetLocation

shouldUseAlternateTargetLocation: object

serializedName

serializedName: string = "shouldUseAlternateTargetLocation"

type

type: object

name

name: "Boolean" = "Boolean"

targetInfo

targetInfo: object

serializedName

serializedName: string = "targetInfo"

type

type: object

className

className: string = "TargetRestoreInfo"

name

name: "Composite" = "Composite"

Const BEKDetails

BEKDetails: object
interface

An interface representing BEKDetails. BEK is bitlocker encrpytion key.

Optional secretData

secretData: undefined | string
member

{string} [secretData] BEK data.

Optional secretUrl

secretUrl: undefined | string
member

{string} [secretUrl] Secret is BEK.

Optional secretVaultId

secretVaultId: undefined | string
member

{string} [secretVaultId] ID of the Key Vault where this Secret is stored.

serializedName

serializedName: string = "BEKDetails"

type

type: object

className

className: string = "BEKDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

secretData

secretData: object

serializedName

serializedName: string = "secretData"

type

type: object

name

name: "String" = "String"

secretUrl

secretUrl: object

serializedName

serializedName: string = "secretUrl"

type

type: object

name

name: "String" = "String"

secretVaultId

secretVaultId: object

serializedName

serializedName: string = "secretVaultId"

type

type: object

name

name: "String" = "String"

Const BMSBackupEngineQueryObject

BMSBackupEngineQueryObject: object
interface

An interface representing BMSBackupEngineQueryObject. Query parameters to fetch list of backup engines.

Optional expand

expand: undefined | string
member

{string} [expand] attribute to add extended info

serializedName

serializedName: string = "BMSBackupEngineQueryObject"

type

type: object

className

className: string = "BMSBackupEngineQueryObject"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

expand

expand: object

serializedName

serializedName: string = "expand"

type

type: object

name

name: "String" = "String"

Const BMSBackupEnginesQueryObject

BMSBackupEnginesQueryObject: object
interface

An interface representing BMSBackupEnginesQueryObject. Query parameters to fetch list of backup engines.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Backup management type for the backup engine. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional expand

expand: undefined | string
member

{string} [expand] Attribute to add extended info.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the backup engine.

serializedName

serializedName: string = "BMSBackupEnginesQueryObject"

type

type: object

className

className: string = "BMSBackupEnginesQueryObject"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupManagementType

backupManagementType: object

serializedName

serializedName: string = "backupManagementType"

type

type: object

name

name: "String" = "String"

expand

expand: object

serializedName

serializedName: string = "expand"

type

type: object

name

name: "String" = "String"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

Const BMSBackupSummariesQueryObject

BMSBackupSummariesQueryObject: object
interface

An interface representing BMSBackupSummariesQueryObject. Query parameters to fetch backup summaries.

serializedName

serializedName: string = "BMSBackupSummariesQueryObject"

type

type: object
member

{Type} [type] Backup management type for this container. Possible values include: 'Invalid', 'BackupProtectedItemCountSummary', 'BackupProtectionContainerCountSummary'

className

className: string = "BMSBackupSummariesQueryObject"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const BMSContainerQueryObject

BMSContainerQueryObject: object
interface

An interface representing BMSContainerQueryObject. The query filters that can be used with the list containers API.

Optional backupEngineName

backupEngineName: undefined | string
member

{string} [backupEngineName] Backup engine name

backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} backupManagementType Backup management type for this container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional containerType

containerType: ContainerType
member

{ContainerType} [containerType] Type of container for filter. Possible values include: 'Invalid', 'Unknown', 'IaasVMContainer', 'IaasVMServiceContainer', 'DPMContainer', 'AzureBackupServerContainer', 'MABContainer', 'Cluster', 'AzureSqlContainer', 'Windows', 'VCenter', 'VMAppContainer', 'SQLAGWorkLoadContainer', 'StorageContainer', 'GenericContainer'

Optional fabricName

fabricName: undefined | string
member

{string} [fabricName] Fabric name for filter

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of this container.

serializedName

serializedName: string = "BMSContainerQueryObject"

Optional status

status: undefined | string
member

{string} [status] Status of registration of this container with the Recovery Services Vault.

type

type: object

className

className: string = "BMSContainerQueryObject"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupEngineName

backupEngineName: object

serializedName

serializedName: string = "backupEngineName"

type

type: object

name

name: "String" = "String"

backupManagementType

backupManagementType: object

required

required: true = true

serializedName

serializedName: string = "backupManagementType"

type

type: object

name

name: "String" = "String"

containerType

containerType: object

serializedName

serializedName: string = "containerType"

type

type: object

name

name: "String" = "String"

fabricName

fabricName: object

serializedName

serializedName: string = "fabricName"

type

type: object

name

name: "String" = "String"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const BMSContainersInquiryQueryObject

BMSContainersInquiryQueryObject: object
interface

An interface representing BMSContainersInquiryQueryObject. The query filters that can be used with the inquire container API.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Backup management type for this container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

serializedName

serializedName: string = "BMSContainersInquiryQueryObject"

Optional workloadType

workloadType: WorkloadType
member

{WorkloadType} [workloadType] Workload type for this container. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

type

type: object

className

className: string = "BMSContainersInquiryQueryObject"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupManagementType

backupManagementType: object

serializedName

serializedName: string = "backupManagementType"

type

type: object

name

name: "String" = "String"

workloadType

workloadType: object

serializedName

serializedName: string = "workloadType"

type

type: object

name

name: "String" = "String"

Const BMSPOQueryObject

BMSPOQueryObject: object
interface

An interface representing BMSPOQueryObject. Filters to list items that can be backed up.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Backup management type. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional containerName

containerName: undefined | string
member

{string} [containerName] Full name of the container whose Protectable Objects should be returned.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name.

serializedName

serializedName: string = "BMSPOQueryObject"

Optional status

status: undefined | string
member

{string} [status] Backup status query parameter.

Optional workloadType

workloadType: WorkloadType
member

{WorkloadType} [workloadType] Workload type. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

type

type: object

className

className: string = "BMSPOQueryObject"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupManagementType

backupManagementType: object

serializedName

serializedName: string = "backupManagementType"

type

type: object

name

name: "String" = "String"

containerName

containerName: object

serializedName

serializedName: string = "containerName"

type

type: object

name

name: "String" = "String"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

workloadType

workloadType: object

serializedName

serializedName: string = "workloadType"

type

type: object

name

name: "String" = "String"

Const BMSRPQueryObject

BMSRPQueryObject: object
interface

An interface representing BMSRPQueryObject. Filters to list backup copies.

Optional endDate

endDate: Date
member

{Date} [endDate] Backup copies created before this time.

Optional extendedInfo

extendedInfo: undefined | false | true
member

{boolean} [extendedInfo] In Get Recovery Point, it tells whether extended information about recovery point is asked.

Optional restorePointQueryType

restorePointQueryType: RestorePointQueryType
member

{RestorePointQueryType} [restorePointQueryType] RestorePoint type. Possible values include: 'Invalid', 'Full', 'Log', 'Differential', 'FullAndDifferential', 'All'

serializedName

serializedName: string = "BMSRPQueryObject"

Optional startDate

startDate: Date
member

{Date} [startDate] Backup copies created after this time.

type

type: object

className

className: string = "BMSRPQueryObject"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endDate

endDate: object

serializedName

serializedName: string = "endDate"

type

type: object

name

name: "DateTime" = "DateTime"

extendedInfo

extendedInfo: object

serializedName

serializedName: string = "extendedInfo"

type

type: object

name

name: "Boolean" = "Boolean"

restorePointQueryType

restorePointQueryType: object

serializedName

serializedName: string = "restorePointQueryType"

type

type: object

name

name: "String" = "String"

startDate

startDate: object

serializedName

serializedName: string = "startDate"

type

type: object

name

name: "DateTime" = "DateTime"

Const BMSRefreshContainersQueryObject

BMSRefreshContainersQueryObject: object
interface

An interface representing BMSRefreshContainersQueryObject. The query filters that can be used with the refresh container API.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Backup management type for this container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

serializedName

serializedName: string = "BMSRefreshContainersQueryObject"

type

type: object

className

className: string = "BMSRefreshContainersQueryObject"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupManagementType

backupManagementType: object

serializedName

serializedName: string = "backupManagementType"

type

type: object

name

name: "String" = "String"

Const BMSWorkloadItemQueryObject

BMSWorkloadItemQueryObject: object
interface

An interface representing BMSWorkloadItemQueryObject. Filters to list items that can be backed up.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Backup management type. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional protectionStatus

protectionStatus: ProtectionStatus
member

{ProtectionStatus} [protectionStatus] Backup status query parameter. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "BMSWorkloadItemQueryObject"

Optional workloadItemType

workloadItemType: WorkloadItemType
member

{WorkloadItemType} [workloadItemType] Workload Item type. Possible values include: 'Invalid', 'SQLInstance', 'SQLDataBase', 'SAPHanaSystem', 'SAPHanaDatabase'

Optional workloadType

workloadType: WorkloadType
member

{WorkloadType} [workloadType] Workload type. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

type

type: object

className

className: string = "BMSWorkloadItemQueryObject"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupManagementType

backupManagementType: object

serializedName

serializedName: string = "backupManagementType"

type

type: object

name

name: "String" = "String"

protectionStatus

protectionStatus: object

serializedName

serializedName: string = "protectionStatus"

type

type: object

name

name: "String" = "String"

workloadItemType

workloadItemType: object

serializedName

serializedName: string = "workloadItemType"

type

type: object

name

name: "String" = "String"

workloadType

workloadType: object

serializedName

serializedName: string = "workloadType"

type

type: object

name

name: "String" = "String"

Const BackupEngineBase

BackupEngineBase: object
interface

An interface representing BackupEngineBase. The base backup engine class. All workload specific backup engines derive from this class.

Optional azureBackupAgentVersion

azureBackupAgentVersion: undefined | string
member

{string} [azureBackupAgentVersion] Backup agent version

Optional backupEngineId

backupEngineId: undefined | string
member

{string} [backupEngineId] ID of the backup engine.

Optional backupEngineState

backupEngineState: undefined | string
member

{string} [backupEngineState] Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed}

backupEngineType

backupEngineType: "BackupEngineBase"
member

{string} backupEngineType Polymorphic Discriminator

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup management for the backup engine. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional canReRegister

canReRegister: undefined | false | true
member

{boolean} [canReRegister] Flag indicating if the backup engine be registered, once already registered.

Optional dpmVersion

dpmVersion: undefined | string
member

{string} [dpmVersion] Backup engine version

Optional extendedInfo

extendedInfo: BackupEngineExtendedInfo
member

{BackupEngineExtendedInfo} [extendedInfo] Extended info of the backupengine

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the backup engine.

Optional healthStatus

healthStatus: undefined | string
member

{string} [healthStatus] Backup status of the backup engine.

Optional isAzureBackupAgentUpgradeAvailable

isAzureBackupAgentUpgradeAvailable: undefined | false | true
member

{boolean} [isAzureBackupAgentUpgradeAvailable] To check if backup agent upgrade available

Optional isDpmUpgradeAvailable

isDpmUpgradeAvailable: undefined | false | true
member

{boolean} [isDpmUpgradeAvailable] To check if backup engine upgrade available

Optional registrationStatus

registrationStatus: undefined | string
member

{string} [registrationStatus] Registration status of the backup engine with the Recovery Services Vault.

serializedName

serializedName: string = "BackupEngineBase"

type

type: object

className

className: string = "BackupEngineBase"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "BackupEngineBase"

modelProperties

modelProperties: object

azureBackupAgentVersion

azureBackupAgentVersion: object

serializedName

serializedName: string = "azureBackupAgentVersion"

type

type: object

name

name: "String" = "String"

backupEngineId

backupEngineId: object

serializedName

serializedName: string = "backupEngineId"

type

type: object

name

name: "String" = "String"

backupEngineState

backupEngineState: object

serializedName

serializedName: string = "backupEngineState"

type

type: object

name

name: "String" = "String"

backupEngineType

backupEngineType: object

required

required: true = true

serializedName

serializedName: string = "backupEngineType"

type

type: object

name

name: "String" = "String"

backupManagementType

backupManagementType: object

serializedName

serializedName: string = "backupManagementType"

type

type: object

name

name: "String" = "String"

canReRegister

canReRegister: object

serializedName

serializedName: string = "canReRegister"

type

type: object

name

name: "Boolean" = "Boolean"

dpmVersion

dpmVersion: object

serializedName

serializedName: string = "dpmVersion"

type

type: object

name

name: "String" = "String"

extendedInfo

extendedInfo: object

serializedName

serializedName: string = "extendedInfo"

type

type: object

className

className: string = "BackupEngineExtendedInfo"

name

name: "Composite" = "Composite"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

healthStatus

healthStatus: object

serializedName

serializedName: string = "healthStatus"

type

type: object

name

name: "String" = "String"

isAzureBackupAgentUpgradeAvailable

isAzureBackupAgentUpgradeAvailable: object

serializedName

serializedName: string = "isAzureBackupAgentUpgradeAvailable"

type

type: object

name

name: "Boolean" = "Boolean"

isDpmUpgradeAvailable

isDpmUpgradeAvailable: object

serializedName

serializedName: string = "isDpmUpgradeAvailable"

type

type: object

name

name: "Boolean" = "Boolean"

registrationStatus

registrationStatus: object

serializedName

serializedName: string = "registrationStatus"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "backupEngineType"

serializedName

serializedName: string = "backupEngineType"

Const BackupEngineBaseResource

BackupEngineBaseResource: object
interface

An interface representing BackupEngineBaseResource. The base backup engine class. All workload specific backup engines derive from this class.

extends

Resource

Optional eTag

eTag: undefined | string
member

{string} [eTag] Optional ETag.

Optional id

id: undefined | string
member

{string} [id] Resource Id represents the complete path to the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource location.

Optional name

name: undefined | string
member

{string} [name] Resource name associated with the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: BackupEngineBaseUnion
member

{BackupEngineBaseUnion} [properties] BackupEngineBaseResource properties

serializedName

serializedName: string = "BackupEngineBaseResource"

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

type

type: object

className

className: string = "BackupEngineBaseResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "BackupEngineBase"

name

name: "Composite" = "Composite"

Const BackupEngineBaseResourceList

BackupEngineBaseResourceList: object
interface

An interface representing the BackupEngineBaseResourceList. List of BackupEngineBase resources

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "BackupEngineBaseResourceList"

__@iterator

  • __@iterator(): IterableIterator<BackupEngineBaseResource>

  • Iterator

    Returns IterableIterator<BackupEngineBaseResource>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<BackupEngineBaseResource>[]): BackupEngineBaseResource[]
  • concat(...items: (T | ConcatArray<T>)[]): BackupEngineBaseResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<BackupEngineBaseResource>[]

      Additional items to add to the end of array1.

    Returns BackupEngineBaseResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns BackupEngineBaseResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, BackupEngineBaseResource]>

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, BackupEngineBaseResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: BackupEngineBaseResource, index: number, array: BackupEngineBaseResource[]): boolean

        • Parameters

          • value: BackupEngineBaseResource
          • index: number
          • array: BackupEngineBaseResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: BackupEngineBaseResource, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: BackupEngineBaseResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): BackupEngineBaseResource[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: BackupEngineBaseResource

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BackupEngineBaseResource, index: number, array: BackupEngineBaseResource[]): boolean

        • Parameters

          • value: BackupEngineBaseResource
          • index: number
          • array: BackupEngineBaseResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BackupEngineBaseResource, index: number, array: BackupEngineBaseResource[]): any

        • Parameters

          • value: BackupEngineBaseResource
          • index: number
          • array: BackupEngineBaseResource[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns BackupEngineBaseResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): BackupEngineBaseResource | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: BackupEngineBaseResource

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: BackupEngineBaseResource, index: number, obj: BackupEngineBaseResource[]): boolean

        • Parameters

          • this: void
          • value: BackupEngineBaseResource
          • index: number
          • obj: BackupEngineBaseResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: BackupEngineBaseResource, index: number, obj: BackupEngineBaseResource[]): boolean

        • Parameters

          • value: BackupEngineBaseResource
          • index: number
          • obj: BackupEngineBaseResource[]

          Returns boolean

    • Optional thisArg: any

    Returns BackupEngineBaseResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: BackupEngineBaseResource, index: number, obj: BackupEngineBaseResource[]): boolean

        • Parameters

          • value: BackupEngineBaseResource
          • index: number
          • obj: BackupEngineBaseResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: BackupEngineBaseResource, index: number, array: BackupEngineBaseResource[]): void

        • Parameters

          • value: BackupEngineBaseResource
          • index: number
          • array: BackupEngineBaseResource[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: BackupEngineBaseResource, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: BackupEngineBaseResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: BackupEngineBaseResource, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: BackupEngineBaseResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: BackupEngineBaseResource, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: BackupEngineBaseResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: BackupEngineBaseResource, index: number, array: BackupEngineBaseResource[]): U

        • Parameters

          • value: BackupEngineBaseResource
          • index: number
          • array: BackupEngineBaseResource[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): BackupEngineBaseResource | undefined

  • Removes the last element from an array and returns it.

    Returns BackupEngineBaseResource | undefined

push

  • push(...items: BackupEngineBaseResource[]): number

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: BackupEngineBaseResource[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): BackupEngineBaseResource
  • reduce(callbackfn: function, initialValue: BackupEngineBaseResource): BackupEngineBaseResource
  • reduce<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: BackupEngineBaseResource, currentValue: BackupEngineBaseResource, currentIndex: number, array: BackupEngineBaseResource[]): BackupEngineBaseResource

        • Parameters

          • previousValue: BackupEngineBaseResource
          • currentValue: BackupEngineBaseResource
          • currentIndex: number
          • array: BackupEngineBaseResource[]

          Returns BackupEngineBaseResource

    Returns BackupEngineBaseResource

  • Parameters

    • callbackfn: function
        • (previousValue: BackupEngineBaseResource, currentValue: BackupEngineBaseResource, currentIndex: number, array: BackupEngineBaseResource[]): BackupEngineBaseResource

        • Parameters

          • previousValue: BackupEngineBaseResource
          • currentValue: BackupEngineBaseResource
          • currentIndex: number
          • array: BackupEngineBaseResource[]

          Returns BackupEngineBaseResource

    • initialValue: BackupEngineBaseResource

    Returns BackupEngineBaseResource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BackupEngineBaseResource, currentIndex: number, array: BackupEngineBaseResource[]): U

        • Parameters

          • previousValue: U
          • currentValue: BackupEngineBaseResource
          • currentIndex: number
          • array: BackupEngineBaseResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): BackupEngineBaseResource
  • reduceRight(callbackfn: function, initialValue: BackupEngineBaseResource): BackupEngineBaseResource
  • reduceRight<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: BackupEngineBaseResource, currentValue: BackupEngineBaseResource, currentIndex: number, array: BackupEngineBaseResource[]): BackupEngineBaseResource

        • Parameters

          • previousValue: BackupEngineBaseResource
          • currentValue: BackupEngineBaseResource
          • currentIndex: number
          • array: BackupEngineBaseResource[]

          Returns BackupEngineBaseResource

    Returns BackupEngineBaseResource

  • Parameters

    • callbackfn: function
        • (previousValue: BackupEngineBaseResource, currentValue: BackupEngineBaseResource, currentIndex: number, array: BackupEngineBaseResource[]): BackupEngineBaseResource

        • Parameters

          • previousValue: BackupEngineBaseResource
          • currentValue: BackupEngineBaseResource
          • currentIndex: number
          • array: BackupEngineBaseResource[]

          Returns BackupEngineBaseResource

    • initialValue: BackupEngineBaseResource

    Returns BackupEngineBaseResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BackupEngineBaseResource, currentIndex: number, array: BackupEngineBaseResource[]): U

        • Parameters

          • previousValue: U
          • currentValue: BackupEngineBaseResource
          • currentIndex: number
          • array: BackupEngineBaseResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): BackupEngineBaseResource[]

  • Reverses the elements in an Array.

    Returns BackupEngineBaseResource[]

shift

  • shift(): BackupEngineBaseResource | undefined

  • Removes the first element from an array and returns it.

    Returns BackupEngineBaseResource | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): BackupEngineBaseResource[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns BackupEngineBaseResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: BackupEngineBaseResource, index: number, array: BackupEngineBaseResource[]): boolean

        • Parameters

          • value: BackupEngineBaseResource
          • index: number
          • array: BackupEngineBaseResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): BackupEngineBaseResource[]
  • splice(start: number, deleteCount: number, ...items: BackupEngineBaseResource[]): BackupEngineBaseResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns BackupEngineBaseResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: BackupEngineBaseResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns BackupEngineBaseResource[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: BackupEngineBaseResource[]): number

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: BackupEngineBaseResource[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<BackupEngineBaseResource>

  • Returns an iterable of values in the array

    Returns IterableIterator<BackupEngineBaseResource>

type

type: object

className

className: string = "BackupEngineBaseResourceList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BackupEngineBaseResource"

name

name: "Composite" = "Composite"

Const BackupEngineExtendedInfo

BackupEngineExtendedInfo: object
interface

An interface representing BackupEngineExtendedInfo. Additional information on backup engine.

Optional availableDiskSpace

availableDiskSpace: undefined | number
member

{number} [availableDiskSpace] Diskspace currently available in the backup engine.

Optional azureProtectedInstances

azureProtectedInstances: undefined | number
member

{number} [azureProtectedInstances] Protected instances in the backup engine.

Optional databaseName

databaseName: undefined | string
member

{string} [databaseName] Database name of backup engine.

Optional diskCount

diskCount: undefined | number
member

{number} [diskCount] Number of disks in the backup engine.

Optional protectedItemsCount

protectedItemsCount: undefined | number
member

{number} [protectedItemsCount] Number of protected items in the backup engine.

Optional protectedServersCount

protectedServersCount: undefined | number
member

{number} [protectedServersCount] Number of protected servers in the backup engine.

Optional refreshedAt

refreshedAt: Date
member

{Date} [refreshedAt] Last refresh time in the backup engine.

serializedName

serializedName: string = "BackupEngineExtendedInfo"

Optional usedDiskSpace

usedDiskSpace: undefined | number
member

{number} [usedDiskSpace] Diskspace used in the backup engine.

type

type: object

className

className: string = "BackupEngineExtendedInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

availableDiskSpace

availableDiskSpace: object

serializedName

serializedName: string = "availableDiskSpace"

type

type: object

name

name: "Number" = "Number"

azureProtectedInstances

azureProtectedInstances: object

serializedName

serializedName: string = "azureProtectedInstances"

type

type: object

name

name: "Number" = "Number"

databaseName

databaseName: object

serializedName

serializedName: string = "databaseName"

type

type: object

name

name: "String" = "String"

diskCount

diskCount: object

serializedName

serializedName: string = "diskCount"

type

type: object

name

name: "Number" = "Number"

protectedItemsCount

protectedItemsCount: object

serializedName

serializedName: string = "protectedItemsCount"

type

type: object

name

name: "Number" = "Number"

protectedServersCount

protectedServersCount: object

serializedName

serializedName: string = "protectedServersCount"

type

type: object

name

name: "Number" = "Number"

refreshedAt

refreshedAt: object

serializedName

serializedName: string = "refreshedAt"

type

type: object

name

name: "DateTime" = "DateTime"

usedDiskSpace

usedDiskSpace: object

serializedName

serializedName: string = "usedDiskSpace"

type

type: object

name

name: "Number" = "Number"

Const BackupManagementUsage

BackupManagementUsage: object
interface

An interface representing BackupManagementUsage. Backup management usages of a vault.

Optional currentValue

currentValue: undefined | number
member

{number} [currentValue] Current value of usage.

Optional limit

limit: undefined | number
member

{number} [limit] Limit of usage.

Optional name

name: NameInfo
member

{NameInfo} [name] Name of usage.

Optional nextResetTime

nextResetTime: Date
member

{Date} [nextResetTime] Next reset time of usage.

Optional quotaPeriod

quotaPeriod: undefined | string
member

{string} [quotaPeriod] Quota period of usage.

serializedName

serializedName: string = "BackupManagementUsage"

Optional unit

unit: UsagesUnit
member

{UsagesUnit} [unit] Unit of the usage. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', 'CountPerSecond', 'BytesPerSecond'

type

type: object

className

className: string = "BackupManagementUsage"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

currentValue

currentValue: object

serializedName

serializedName: string = "currentValue"

type

type: object

name

name: "Number" = "Number"

limit

limit: object

serializedName

serializedName: string = "limit"

type

type: object

name

name: "Number" = "Number"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

className

className: string = "NameInfo"

name

name: "Composite" = "Composite"

nextResetTime

nextResetTime: object

serializedName

serializedName: string = "nextResetTime"

type

type: object

name

name: "DateTime" = "DateTime"

quotaPeriod

quotaPeriod: object

serializedName

serializedName: string = "quotaPeriod"

type

type: object

name

name: "String" = "String"

unit

unit: object

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

Const BackupManagementUsageList

BackupManagementUsageList: object
interface

An interface representing the BackupManagementUsageList. Backup management usage for vault.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "BackupManagementUsageList"

__@iterator

  • __@iterator(): IterableIterator<BackupManagementUsage>

  • Iterator

    Returns IterableIterator<BackupManagementUsage>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<BackupManagementUsage>[]): BackupManagementUsage[]
  • concat(...items: (T | ConcatArray<T>)[]): BackupManagementUsage[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<BackupManagementUsage>[]

      Additional items to add to the end of array1.

    Returns BackupManagementUsage[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns BackupManagementUsage[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, BackupManagementUsage]>

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, BackupManagementUsage]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: BackupManagementUsage, index: number, array: BackupManagementUsage[]): boolean

        • Parameters

          • value: BackupManagementUsage
          • index: number
          • array: BackupManagementUsage[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: BackupManagementUsage, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: BackupManagementUsage

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): BackupManagementUsage[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: BackupManagementUsage

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BackupManagementUsage, index: number, array: BackupManagementUsage[]): boolean

        • Parameters

          • value: BackupManagementUsage
          • index: number
          • array: BackupManagementUsage[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BackupManagementUsage, index: number, array: BackupManagementUsage[]): any

        • Parameters

          • value: BackupManagementUsage
          • index: number
          • array: BackupManagementUsage[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns BackupManagementUsage[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): BackupManagementUsage | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: BackupManagementUsage

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: BackupManagementUsage, index: number, obj: BackupManagementUsage[]): boolean

        • Parameters

          • this: void
          • value: BackupManagementUsage
          • index: number
          • obj: BackupManagementUsage[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: BackupManagementUsage, index: number, obj: BackupManagementUsage[]): boolean

        • Parameters

          • value: BackupManagementUsage
          • index: number
          • obj: BackupManagementUsage[]

          Returns boolean

    • Optional thisArg: any

    Returns BackupManagementUsage | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: BackupManagementUsage, index: number, obj: BackupManagementUsage[]): boolean

        • Parameters

          • value: BackupManagementUsage
          • index: number
          • obj: BackupManagementUsage[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: BackupManagementUsage, index: number, array: BackupManagementUsage[]): void

        • Parameters

          • value: BackupManagementUsage
          • index: number
          • array: BackupManagementUsage[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: BackupManagementUsage, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: BackupManagementUsage

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: BackupManagementUsage, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: BackupManagementUsage

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: BackupManagementUsage, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: BackupManagementUsage

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: BackupManagementUsage, index: number, array: BackupManagementUsage[]): U

        • Parameters

          • value: BackupManagementUsage
          • index: number
          • array: BackupManagementUsage[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): BackupManagementUsage | undefined

  • Removes the last element from an array and returns it.

    Returns BackupManagementUsage | undefined

push

  • push(...items: BackupManagementUsage[]): number

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: BackupManagementUsage[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): BackupManagementUsage
  • reduce(callbackfn: function, initialValue: BackupManagementUsage): BackupManagementUsage
  • reduce<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: BackupManagementUsage, currentValue: BackupManagementUsage, currentIndex: number, array: BackupManagementUsage[]): BackupManagementUsage

        • Parameters

          • previousValue: BackupManagementUsage
          • currentValue: BackupManagementUsage
          • currentIndex: number
          • array: BackupManagementUsage[]

          Returns BackupManagementUsage

    Returns BackupManagementUsage

  • Parameters

    • callbackfn: function
        • (previousValue: BackupManagementUsage, currentValue: BackupManagementUsage, currentIndex: number, array: BackupManagementUsage[]): BackupManagementUsage

        • Parameters

          • previousValue: BackupManagementUsage
          • currentValue: BackupManagementUsage
          • currentIndex: number
          • array: BackupManagementUsage[]

          Returns BackupManagementUsage

    • initialValue: BackupManagementUsage

    Returns BackupManagementUsage

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BackupManagementUsage, currentIndex: number, array: BackupManagementUsage[]): U

        • Parameters

          • previousValue: U
          • currentValue: BackupManagementUsage
          • currentIndex: number
          • array: BackupManagementUsage[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): BackupManagementUsage
  • reduceRight(callbackfn: function, initialValue: BackupManagementUsage): BackupManagementUsage
  • reduceRight<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: BackupManagementUsage, currentValue: BackupManagementUsage, currentIndex: number, array: BackupManagementUsage[]): BackupManagementUsage

        • Parameters

          • previousValue: BackupManagementUsage
          • currentValue: BackupManagementUsage
          • currentIndex: number
          • array: BackupManagementUsage[]

          Returns BackupManagementUsage

    Returns BackupManagementUsage

  • Parameters

    • callbackfn: function
        • (previousValue: BackupManagementUsage, currentValue: BackupManagementUsage, currentIndex: number, array: BackupManagementUsage[]): BackupManagementUsage

        • Parameters

          • previousValue: BackupManagementUsage
          • currentValue: BackupManagementUsage
          • currentIndex: number
          • array: BackupManagementUsage[]

          Returns BackupManagementUsage

    • initialValue: BackupManagementUsage

    Returns BackupManagementUsage

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BackupManagementUsage, currentIndex: number, array: BackupManagementUsage[]): U

        • Parameters

          • previousValue: U
          • currentValue: BackupManagementUsage
          • currentIndex: number
          • array: BackupManagementUsage[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): BackupManagementUsage[]

  • Reverses the elements in an Array.

    Returns BackupManagementUsage[]

shift

  • shift(): BackupManagementUsage | undefined

  • Removes the first element from an array and returns it.

    Returns BackupManagementUsage | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): BackupManagementUsage[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns BackupManagementUsage[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: BackupManagementUsage, index: number, array: BackupManagementUsage[]): boolean

        • Parameters

          • value: BackupManagementUsage
          • index: number
          • array: BackupManagementUsage[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): BackupManagementUsage[]
  • splice(start: number, deleteCount: number, ...items: BackupManagementUsage[]): BackupManagementUsage[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns BackupManagementUsage[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: BackupManagementUsage[]

      Elements to insert into the array in place of the deleted elements.

    Returns BackupManagementUsage[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: BackupManagementUsage[]): number

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: BackupManagementUsage[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<BackupManagementUsage>

  • Returns an iterable of values in the array

    Returns IterableIterator<BackupManagementUsage>

type

type: object

className

className: string = "BackupManagementUsageList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BackupManagementUsage"

name

name: "Composite" = "Composite"

Const BackupRequest

BackupRequest: object
interface

An interface representing BackupRequest. Base class for backup request. Workload-specific backup requests are derived from this class.

objectType

objectType: "BackupRequest"
member

{string} objectType Polymorphic Discriminator

serializedName

serializedName: string = "BackupRequest"

type

type: object

className

className: string = "BackupRequest"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "BackupRequest"

modelProperties

modelProperties: object

objectType

objectType: object

required

required: true = true

serializedName

serializedName: string = "objectType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "objectType"

serializedName

serializedName: string = "objectType"

Const BackupRequestResource

BackupRequestResource: object
interface

An interface representing BackupRequestResource. Base class for backup request. Workload-specific backup requests are derived from this class.

extends

Resource

Optional eTag

eTag: undefined | string
member

{string} [eTag] Optional ETag.

Optional id

id: undefined | string
member

{string} [id] Resource Id represents the complete path to the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource location.

Optional name

name: undefined | string
member

{string} [name] Resource name associated with the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: BackupRequestUnion
member

{BackupRequestUnion} [properties] BackupRequestResource properties

serializedName

serializedName: string = "BackupRequestResource"

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

type

type: object

className

className: string = "BackupRequestResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "BackupRequest"

name

name: "Composite" = "Composite"

Const BackupResourceConfig

BackupResourceConfig: object
interface

An interface representing BackupResourceConfig. The resource storage details.

serializedName

serializedName: string = "BackupResourceConfig"

Optional storageModelType

storageModelType: StorageType
member

{StorageType} [storageModelType] Storage type. Possible values include: 'Invalid', 'GeoRedundant', 'LocallyRedundant'

Optional storageType

storageType: StorageType
member

{StorageType} [storageType] Storage type. Possible values include: 'Invalid', 'GeoRedundant', 'LocallyRedundant'

Optional storageTypeState

storageTypeState: StorageTypeState
member

{StorageTypeState} [storageTypeState] Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. Possible values include: 'Invalid', 'Locked', 'Unlocked'

type

type: object

className

className: string = "BackupResourceConfig"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

storageModelType

storageModelType: object

serializedName

serializedName: string = "storageModelType"

type

type: object

name

name: "String" = "String"

storageType

storageType: object

serializedName

serializedName: string = "storageType"

type

type: object

name

name: "String" = "String"

storageTypeState

storageTypeState: object

serializedName

serializedName: string = "storageTypeState"

type

type: object

name

name: "String" = "String"

Const BackupResourceConfigResource

BackupResourceConfigResource: object
interface

An interface representing BackupResourceConfigResource. The resource storage details.

extends

Resource

Optional eTag

eTag: undefined | string
member

{string} [eTag] Optional ETag.

Optional id

id: undefined | string
member

{string} [id] Resource Id represents the complete path to the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource location.

Optional name

name: undefined | string
member

{string} [name] Resource name associated with the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: BackupResourceConfig
member

{BackupResourceConfig} [properties] BackupResourceConfigResource properties

serializedName

serializedName: string = "BackupResourceConfigResource"

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

type

type: object

className

className: string = "BackupResourceConfigResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "BackupResourceConfig"

name

name: "Composite" = "Composite"

Const BackupResourceVaultConfig

BackupResourceVaultConfig: object
interface

An interface representing BackupResourceVaultConfig. Backup resource vault config details.

Optional enhancedSecurityState

enhancedSecurityState: EnhancedSecurityState
member

{EnhancedSecurityState} [enhancedSecurityState] Enabled or Disabled. Possible values include: 'Invalid', 'Enabled', 'Disabled'

serializedName

serializedName: string = "BackupResourceVaultConfig"

Optional storageModelType

storageModelType: StorageType
member

{StorageType} [storageModelType] Storage type. Possible values include: 'Invalid', 'GeoRedundant', 'LocallyRedundant'

Optional storageType

storageType: StorageType
member

{StorageType} [storageType] Storage type. Possible values include: 'Invalid', 'GeoRedundant', 'LocallyRedundant'

Optional storageTypeState

storageTypeState: StorageTypeState
member

{StorageTypeState} [storageTypeState] Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. Possible values include: 'Invalid', 'Locked', 'Unlocked'

type

type: object

className

className: string = "BackupResourceVaultConfig"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enhancedSecurityState

enhancedSecurityState: object

serializedName

serializedName: string = "enhancedSecurityState"

type

type: object

name

name: "String" = "String"

storageModelType

storageModelType: object

serializedName

serializedName: string = "storageModelType"

type

type: object

name

name: "String" = "String"

storageType

storageType: object

serializedName

serializedName: string = "storageType"

type

type: object

name

name: "String" = "String"

storageTypeState

storageTypeState: object

serializedName

serializedName: string = "storageTypeState"

type

type: object

name

name: "String" = "String"

Const BackupResourceVaultConfigResource

BackupResourceVaultConfigResource: object
interface

An interface representing BackupResourceVaultConfigResource. Backup resource vault config details.

extends

Resource

Optional eTag

eTag: undefined | string
member

{string} [eTag] Optional ETag.

Optional id

id: undefined | string
member

{string} [id] Resource Id represents the complete path to the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource location.

Optional name

name: undefined | string
member

{string} [name] Resource name associated with the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: BackupResourceVaultConfig
member

{BackupResourceVaultConfig} [properties] BackupResourceVaultConfigResource properties

serializedName

serializedName: string = "BackupResourceVaultConfigResource"

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

type

type: object

className

className: string = "BackupResourceVaultConfigResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "BackupResourceVaultConfig"

name

name: "Composite" = "Composite"

Const BackupStatusRequest

BackupStatusRequest: object
interface

An interface representing BackupStatusRequest. BackupStatus request.

Optional poLogicalName

poLogicalName: undefined | string
member

{string} [poLogicalName] Protectable Item Logical Name

Optional resourceId

resourceId: undefined | string
member

{string} [resourceId] Entire ARM resource id of the resource

Optional resourceType

resourceType: DataSourceType
member

{DataSourceType} [resourceType] Container Type - VM, SQLPaaS, DPM, AzureFileShare. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

serializedName

serializedName: string = "BackupStatusRequest"

type

type: object

className

className: string = "BackupStatusRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

poLogicalName

poLogicalName: object

serializedName

serializedName: string = "poLogicalName"

type

type: object

name

name: "String" = "String"

resourceId

resourceId: object

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

resourceType

resourceType: object

serializedName

serializedName: string = "resourceType"

type

type: object

name

name: "String" = "String"

Const BackupStatusResponse

BackupStatusResponse: object
interface

An interface representing BackupStatusResponse. BackupStatus response.

Optional containerName

containerName: undefined | string
member

{string} [containerName] Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;csname;vmname.

Optional errorCode

errorCode: undefined | string
member

{string} [errorCode] ErrorCode in case of intent failed

Optional errorMessage

errorMessage: undefined | string
member

{string} [errorMessage] ErrorMessage in case of intent failed.

Optional fabricName

fabricName: FabricName
member

{FabricName} [fabricName] Specifies the fabric name - Azure or AD. Possible values include: 'Invalid', 'Azure'

Optional policyName

policyName: undefined | string
member

{string} [policyName] Specifies the policy name which is used for protection

Optional protectedItemName

protectedItemName: undefined | string
member

{string} [protectedItemName] Specifies the product specific ds name. E.g. vm;iaasvmcontainer;csname;vmname.

Optional protectionStatus

protectionStatus: ProtectionStatus
member

{ProtectionStatus} [protectionStatus] Specifies whether the container is registered or not. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

Optional registrationStatus

registrationStatus: undefined | string
member

{string} [registrationStatus] Container registration status

serializedName

serializedName: string = "BackupStatusResponse"

type

type: object

className

className: string = "BackupStatusResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containerName

containerName: object

serializedName

serializedName: string = "containerName"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "errorCode"

type

type: object

name

name: "String" = "String"

errorMessage

errorMessage: object

serializedName

serializedName: string = "errorMessage"

type

type: object

name

name: "String" = "String"

fabricName

fabricName: object

serializedName

serializedName: string = "fabricName"

type

type: object

name

name: "String" = "String"

policyName

policyName: object

serializedName

serializedName: string = "policyName"

type

type: object

name

name: "String" = "String"

protectedItemName

protectedItemName: object

serializedName

serializedName: string = "protectedItemName"

type

type: object

name

name: "String" = "String"

protectionStatus

protectionStatus: object

serializedName

serializedName: string = "protectionStatus"

type

type: object

name

name: "String" = "String"

registrationStatus

registrationStatus: object

serializedName

serializedName: string = "registrationStatus"

type

type: object

name

name: "String" = "String"

Const ClientDiscoveryDisplay

ClientDiscoveryDisplay: object
interface

An interface representing ClientDiscoveryDisplay. Localized display information of an operation.

Optional description

description: undefined | string
member

{string} [description] Description of the operation having details of what operation is about.

Optional operation

operation: undefined | string
member

{string} [operation] Operations Name itself.

Optional provider

provider: undefined | string
member

{string} [provider] Name of the provider for display purposes

Optional resource

resource: undefined | string
member

{string} [resource] ResourceType for which this Operation can be performed.

serializedName

serializedName: string = "ClientDiscoveryDisplay"

type

type: object

className

className: string = "ClientDiscoveryDisplay"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

operation

operation: object

serializedName

serializedName: string = "operation"

type

type: object

name

name: "String" = "String"

provider

provider: object

serializedName

serializedName: string = "provider"

type

type: object

name

name: "String" = "String"

resource

resource: object

serializedName

serializedName: string = "resource"

type

type: object

name

name: "String" = "String"

Const ClientDiscoveryForLogSpecification

ClientDiscoveryForLogSpecification: object
interface

An interface representing ClientDiscoveryForLogSpecification. Class to represent shoebox log specification in json client discovery.

Optional blobDuration

blobDuration: undefined | string
member

{string} [blobDuration] blob duration of shoebox log specification

Optional displayName

displayName: undefined | string
member

{string} [displayName] Localized display name

Optional name

name: undefined | string
member

{string} [name] Name for shoebox log specification.

serializedName

serializedName: string = "ClientDiscoveryForLogSpecification"

type

type: object

className

className: string = "ClientDiscoveryForLogSpecification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobDuration

blobDuration: object

serializedName

serializedName: string = "blobDuration"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const ClientDiscoveryForProperties

ClientDiscoveryForProperties: object
interface

An interface representing ClientDiscoveryForProperties. Class to represent shoebox properties in json client discovery.

serializedName

serializedName: string = "ClientDiscoveryForProperties"

Optional serviceSpecification

serviceSpecification: ClientDiscoveryForServiceSpecification
member

{ClientDiscoveryForServiceSpecification} [serviceSpecification] Operation properties.

type

type: object

className

className: string = "ClientDiscoveryForProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

serviceSpecification

serviceSpecification: object

serializedName

serializedName: string = "serviceSpecification"

type

type: object

className

className: string = "ClientDiscoveryForServiceSpecification"

name

name: "Composite" = "Composite"

Const ClientDiscoveryForServiceSpecification

ClientDiscoveryForServiceSpecification: object
interface

An interface representing ClientDiscoveryForServiceSpecification. Class to represent shoebox service specification in json client discovery.

Optional logSpecifications

logSpecifications: ClientDiscoveryForLogSpecification[]
member

{ClientDiscoveryForLogSpecification[]} [logSpecifications] List of log specifications of this operation.

serializedName

serializedName: string = "ClientDiscoveryForServiceSpecification"

type

type: object

className

className: string = "ClientDiscoveryForServiceSpecification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

logSpecifications

logSpecifications: object

serializedName

serializedName: string = "logSpecifications"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ClientDiscoveryForLogSpecification"

name

name: "Composite" = "Composite"

Const ClientDiscoveryResponse

ClientDiscoveryResponse: object
interface

An interface representing the ClientDiscoveryResponse. Operations List response which contains list of available APIs.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] Link to the next chunk of Response.

serializedName

serializedName: string = "ClientDiscoveryResponse"

__@iterator

  • __@iterator(): IterableIterator<ClientDiscoveryValueForSingleApi>

  • Iterator

    Returns IterableIterator<ClientDiscoveryValueForSingleApi>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ClientDiscoveryValueForSingleApi>[]): ClientDiscoveryValueForSingleApi[]
  • concat(...items: (T | ConcatArray<T>)[]): ClientDiscoveryValueForSingleApi[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ClientDiscoveryValueForSingleApi>[]

      Additional items to add to the end of array1.

    Returns ClientDiscoveryValueForSingleApi[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ClientDiscoveryValueForSingleApi[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ClientDiscoveryValueForSingleApi]>

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ClientDiscoveryValueForSingleApi]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ClientDiscoveryValueForSingleApi, index: number, array: ClientDiscoveryValueForSingleApi[]): boolean

        • Parameters

          • value: ClientDiscoveryValueForSingleApi
          • index: number
          • array: ClientDiscoveryValueForSingleApi[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ClientDiscoveryValueForSingleApi, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ClientDiscoveryValueForSingleApi

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ClientDiscoveryValueForSingleApi[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ClientDiscoveryValueForSingleApi

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ClientDiscoveryValueForSingleApi, index: number, array: ClientDiscoveryValueForSingleApi[]): boolean

        • Parameters

          • value: ClientDiscoveryValueForSingleApi
          • index: number
          • array: ClientDiscoveryValueForSingleApi[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ClientDiscoveryValueForSingleApi, index: number, array: ClientDiscoveryValueForSingleApi[]): any

        • Parameters

          • value: ClientDiscoveryValueForSingleApi
          • index: number
          • array: ClientDiscoveryValueForSingleApi[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ClientDiscoveryValueForSingleApi[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ClientDiscoveryValueForSingleApi | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ClientDiscoveryValueForSingleApi

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ClientDiscoveryValueForSingleApi, index: number, obj: ClientDiscoveryValueForSingleApi[]): boolean

        • Parameters

          • this: void
          • value: ClientDiscoveryValueForSingleApi
          • index: number
          • obj: ClientDiscoveryValueForSingleApi[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ClientDiscoveryValueForSingleApi, index: number, obj: ClientDiscoveryValueForSingleApi[]): boolean

        • Parameters

          • value: ClientDiscoveryValueForSingleApi
          • index: number
          • obj: ClientDiscoveryValueForSingleApi[]

          Returns boolean

    • Optional thisArg: any

    Returns ClientDiscoveryValueForSingleApi | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ClientDiscoveryValueForSingleApi, index: number, obj: ClientDiscoveryValueForSingleApi[]): boolean

        • Parameters

          • value: ClientDiscoveryValueForSingleApi
          • index: number
          • obj: ClientDiscoveryValueForSingleApi[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ClientDiscoveryValueForSingleApi, index: number, array: ClientDiscoveryValueForSingleApi[]): void

        • Parameters

          • value: ClientDiscoveryValueForSingleApi
          • index: number
          • array: ClientDiscoveryValueForSingleApi[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ClientDiscoveryValueForSingleApi, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ClientDiscoveryValueForSingleApi

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ClientDiscoveryValueForSingleApi, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ClientDiscoveryValueForSingleApi

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ClientDiscoveryValueForSingleApi, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ClientDiscoveryValueForSingleApi

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ClientDiscoveryValueForSingleApi, index: number, array: ClientDiscoveryValueForSingleApi[]): U

        • Parameters

          • value: ClientDiscoveryValueForSingleApi
          • index: number
          • array: ClientDiscoveryValueForSingleApi[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ClientDiscoveryValueForSingleApi | undefined

  • Removes the last element from an array and returns it.

    Returns ClientDiscoveryValueForSingleApi | undefined

push

  • push(...items: ClientDiscoveryValueForSingleApi[]): number

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ClientDiscoveryValueForSingleApi[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ClientDiscoveryValueForSingleApi
  • reduce(callbackfn: function, initialValue: ClientDiscoveryValueForSingleApi): ClientDiscoveryValueForSingleApi
  • reduce<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ClientDiscoveryValueForSingleApi, currentValue: ClientDiscoveryValueForSingleApi, currentIndex: number, array: ClientDiscoveryValueForSingleApi[]): ClientDiscoveryValueForSingleApi

        • Parameters

          • previousValue: ClientDiscoveryValueForSingleApi
          • currentValue: ClientDiscoveryValueForSingleApi
          • currentIndex: number
          • array: ClientDiscoveryValueForSingleApi[]

          Returns ClientDiscoveryValueForSingleApi

    Returns ClientDiscoveryValueForSingleApi

  • Parameters

    • callbackfn: function
        • (previousValue: ClientDiscoveryValueForSingleApi, currentValue: ClientDiscoveryValueForSingleApi, currentIndex: number, array: ClientDiscoveryValueForSingleApi[]): ClientDiscoveryValueForSingleApi

        • Parameters

          • previousValue: ClientDiscoveryValueForSingleApi
          • currentValue: ClientDiscoveryValueForSingleApi
          • currentIndex: number
          • array: ClientDiscoveryValueForSingleApi[]

          Returns ClientDiscoveryValueForSingleApi

    • initialValue: ClientDiscoveryValueForSingleApi

    Returns ClientDiscoveryValueForSingleApi

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ClientDiscoveryValueForSingleApi, currentIndex: number, array: ClientDiscoveryValueForSingleApi[]): U

        • Parameters

          • previousValue: U
          • currentValue: ClientDiscoveryValueForSingleApi
          • currentIndex: number
          • array: ClientDiscoveryValueForSingleApi[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ClientDiscoveryValueForSingleApi
  • reduceRight(callbackfn: function, initialValue: ClientDiscoveryValueForSingleApi): ClientDiscoveryValueForSingleApi
  • reduceRight<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ClientDiscoveryValueForSingleApi, currentValue: ClientDiscoveryValueForSingleApi, currentIndex: number, array: ClientDiscoveryValueForSingleApi[]): ClientDiscoveryValueForSingleApi

        • Parameters

          • previousValue: ClientDiscoveryValueForSingleApi
          • currentValue: ClientDiscoveryValueForSingleApi
          • currentIndex: number
          • array: ClientDiscoveryValueForSingleApi[]

          Returns ClientDiscoveryValueForSingleApi

    Returns ClientDiscoveryValueForSingleApi

  • Parameters

    • callbackfn: function
        • (previousValue: ClientDiscoveryValueForSingleApi, currentValue: ClientDiscoveryValueForSingleApi, currentIndex: number, array: ClientDiscoveryValueForSingleApi[]): ClientDiscoveryValueForSingleApi

        • Parameters

          • previousValue: ClientDiscoveryValueForSingleApi
          • currentValue: ClientDiscoveryValueForSingleApi
          • currentIndex: number
          • array: ClientDiscoveryValueForSingleApi[]

          Returns ClientDiscoveryValueForSingleApi

    • initialValue: ClientDiscoveryValueForSingleApi

    Returns ClientDiscoveryValueForSingleApi

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ClientDiscoveryValueForSingleApi, currentIndex: number, array: ClientDiscoveryValueForSingleApi[]): U

        • Parameters

          • previousValue: U
          • currentValue: ClientDiscoveryValueForSingleApi
          • currentIndex: number
          • array: ClientDiscoveryValueForSingleApi[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ClientDiscoveryValueForSingleApi[]

  • Reverses the elements in an Array.

    Returns ClientDiscoveryValueForSingleApi[]

shift

  • shift(): ClientDiscoveryValueForSingleApi | undefined

  • Removes the first element from an array and returns it.

    Returns ClientDiscoveryValueForSingleApi | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ClientDiscoveryValueForSingleApi[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ClientDiscoveryValueForSingleApi[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ClientDiscoveryValueForSingleApi, index: number, array: ClientDiscoveryValueForSingleApi[]): boolean

        • Parameters

          • value: ClientDiscoveryValueForSingleApi
          • index: number
          • array: ClientDiscoveryValueForSingleApi[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ClientDiscoveryValueForSingleApi[]
  • splice(start: number, deleteCount: number, ...items: ClientDiscoveryValueForSingleApi[]): ClientDiscoveryValueForSingleApi[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ClientDiscoveryValueForSingleApi[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ClientDiscoveryValueForSingleApi[]

      Elements to insert into the array in place of the deleted elements.

    Returns ClientDiscoveryValueForSingleApi[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ClientDiscoveryValueForSingleApi[]): number

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ClientDiscoveryValueForSingleApi[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ClientDiscoveryValueForSingleApi>

  • Returns an iterable of values in the array

    Returns IterableIterator<ClientDiscoveryValueForSingleApi>

type

type: object

className

className: string = "ClientDiscoveryResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ClientDiscoveryValueForSingleApi"

name

name: "Composite" = "Composite"

Const ClientDiscoveryValueForSingleApi

ClientDiscoveryValueForSingleApi: object
interface

An interface representing ClientDiscoveryValueForSingleApi. Available operation details.

Optional display

display: ClientDiscoveryDisplay
member

{ClientDiscoveryDisplay} [display] Contains the localized display information for this particular operation

Optional name

name: undefined | string
member

{string} [name] Name of the Operation.

Optional origin

origin: undefined | string
member

{string} [origin] The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX

Optional properties

properties: ClientDiscoveryForProperties
member

{ClientDiscoveryForProperties} [properties] ShoeBox properties for the given operation.

serializedName

serializedName: string = "ClientDiscoveryValueForSingleApi"

type

type: object

className

className: string = "ClientDiscoveryValueForSingleApi"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

display

display: object

serializedName

serializedName: string = "display"

type

type: object

className

className: string = "ClientDiscoveryDisplay"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

origin

origin: object

serializedName

serializedName: string = "origin"

type

type: object

name

name: "String" = "String"

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "ClientDiscoveryForProperties"

name

name: "Composite" = "Composite"

Const ClientScriptForConnect

ClientScriptForConnect: object
interface

An interface representing ClientScriptForConnect. Client script details for file / folder restore.

Optional osType

osType: undefined | string
member

{string} [osType] OS type - Windows, Linux etc. for which this file / folder restore client script works.

Optional scriptContent

scriptContent: undefined | string
member

{string} [scriptContent] File content of the client script for file / folder restore.

Optional scriptExtension

scriptExtension: undefined | string
member

{string} [scriptExtension] File extension of the client script for file / folder restore - .ps1 , .sh , etc.

Optional scriptNameSuffix

scriptNameSuffix: undefined | string
member

{string} [scriptNameSuffix] Mandator suffix that should be added to the name of script that is given for download to user. If its null or empty then , ignore it.

serializedName

serializedName: string = "ClientScriptForConnect"

Optional url

url: undefined | string
member

{string} [url] URL of Executable from where to source the content. If this is not null then ScriptContent should not be used

type

type: object

className

className: string = "ClientScriptForConnect"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

osType

osType: object

serializedName

serializedName: string = "osType"

type

type: object

name

name: "String" = "String"

scriptContent

scriptContent: object

serializedName

serializedName: string = "scriptContent"

type

type: object

name

name: "String" = "String"

scriptExtension

scriptExtension: object

serializedName

serializedName: string = "scriptExtension"

type

type: object

name

name: "String" = "String"

scriptNameSuffix

scriptNameSuffix: object

serializedName

serializedName: string = "scriptNameSuffix"

type

type: object

name

name: "String" = "String"

url

url: object

serializedName

serializedName: string = "url"

type

type: object

name

name: "String" = "String"

Const ContainerIdentityInfo

ContainerIdentityInfo: object
interface

An interface representing ContainerIdentityInfo. Container identity information

Optional aadTenantId

aadTenantId: undefined | string
member

{string} [aadTenantId] Protection container identity - AAD Tenant

Optional audience

audience: undefined | string
member

{string} [audience] Protection container identity - Audience

serializedName

serializedName: string = "ContainerIdentityInfo"

Optional servicePrincipalClientId

servicePrincipalClientId: undefined | string
member

{string} [servicePrincipalClientId] Protection container identity

  • AAD Service Principal

Optional uniqueName

uniqueName: undefined | string
member

{string} [uniqueName] Unique name of the container

type

type: object

className

className: string = "ContainerIdentityInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

aadTenantId

aadTenantId: object

serializedName

serializedName: string = "aadTenantId"

type

type: object

name

name: "String" = "String"

audience

audience: object

serializedName

serializedName: string = "audience"

type

type: object

name

name: "String" = "String"

servicePrincipalClientId

servicePrincipalClientId: object

serializedName

serializedName: string = "servicePrincipalClientId"

type

type: object

name

name: "String" = "String"

uniqueName

uniqueName: object

serializedName

serializedName: string = "uniqueName"

type

type: object

name

name: "String" = "String"

Const DPMContainerExtendedInfo

DPMContainerExtendedInfo: object
interface

An interface representing DPMContainerExtendedInfo. Additional information of the DPMContainer.

Optional lastRefreshedAt

lastRefreshedAt: Date
member

{Date} [lastRefreshedAt] Last refresh time of the DPMContainer.

serializedName

serializedName: string = "DPMContainerExtendedInfo"

type

type: object

className

className: string = "DPMContainerExtendedInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

lastRefreshedAt

lastRefreshedAt: object

serializedName

serializedName: string = "lastRefreshedAt"

type

type: object

name

name: "DateTime" = "DateTime"

Const DPMProtectedItem

DPMProtectedItem: object
interface

An interface representing DPMProtectedItem. Additional information on Backup engine specific backup item.

Optional backupEngineName

backupEngineName: undefined | string
member

{string} [backupEngineName] Backup Management server protecting this backup item

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional backupSetName

backupSetName: undefined | string
member

{string} [backupSetName] Name of the backup set the backup item belongs to

Optional containerName

containerName: undefined | string
member

{string} [containerName] Unique name of container

Optional createMode

createMode: CreateMode
member

{CreateMode} [createMode] Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: 'Invalid', 'Default', 'Recover'

Optional extendedInfo

extendedInfo: DPMProtectedItemExtendedInfo
member

{DPMProtectedItemExtendedInfo} [extendedInfo] Extended info of the backup item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the managed item

Optional isScheduledForDeferredDelete

isScheduledForDeferredDelete: undefined | false | true
member

{boolean} [isScheduledForDeferredDelete] To check if backup item is scheduled for deferred delete

Optional lastRecoveryPoint

lastRecoveryPoint: Date
member

{Date} [lastRecoveryPoint] Timestamp when the last (latest) backup copy was created for this backup item.

Optional policyId

policyId: undefined | string
member

{string} [policyId] ID of the backup policy with which this item is backed up.

protectedItemType

protectedItemType: "DPMProtectedItem"
member

{string} protectedItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectedItemState
member

{ProtectedItemState} [protectionState] Protection state of the backupengine. Possible values include: 'Invalid', 'IRPending', 'Protected', 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'

serializedName

serializedName: string = "DPMProtectedItem"

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] ARM ID of the resource to be backed up.

Optional workloadType

workloadType: DataSourceType
member

{DataSourceType} [workloadType] Type of workload this item represents. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

type

type: object

className

className: string = "DPMProtectedItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectedItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectedItem"

modelProperties

modelProperties: object

backupEngineName

backupEngineName: object

serializedName

serializedName: string = "backupEngineName"

type

type: object

name

name: "String" = "String"

extendedInfo

extendedInfo: object

serializedName

serializedName: string = "extendedInfo"

type

type: object

className

className: string = "DPMProtectedItemExtendedInfo"

name

name: "Composite" = "Composite"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

isScheduledForDeferredDelete

isScheduledForDeferredDelete: object

serializedName

serializedName: string = "isScheduledForDeferredDelete"

type

type: object

name

name: "Boolean" = "Boolean"

protectionState

protectionState: object

serializedName

serializedName: string = "protectionState"

type

type: object

name

name: "String" = "String"

Const DPMProtectedItemExtendedInfo

DPMProtectedItemExtendedInfo: object
interface

An interface representing DPMProtectedItemExtendedInfo. Additional information of DPM Protected item.

Optional diskStorageUsedInBytes

diskStorageUsedInBytes: undefined | string
member

{string} [diskStorageUsedInBytes] Used Disk storage in bytes.

Optional isCollocated

isCollocated: undefined | false | true
member

{boolean} [isCollocated] To check if backup item is collocated.

Optional isPresentOnCloud

isPresentOnCloud: undefined | false | true
member

{boolean} [isPresentOnCloud] To check if backup item is cloud protected.

Optional lastBackupStatus

lastBackupStatus: undefined | string
member

{string} [lastBackupStatus] Last backup status information on backup item.

Optional lastRefreshedAt

lastRefreshedAt: Date
member

{Date} [lastRefreshedAt] Last refresh time on backup item.

Optional oldestRecoveryPoint

oldestRecoveryPoint: Date
member

{Date} [oldestRecoveryPoint] Oldest cloud recovery point time.

Optional onPremiseLatestRecoveryPoint

onPremiseLatestRecoveryPoint: Date
member

{Date} [onPremiseLatestRecoveryPoint] latest disk recovery point time.

Optional onPremiseOldestRecoveryPoint

onPremiseOldestRecoveryPoint: Date
member

{Date} [onPremiseOldestRecoveryPoint] Oldest disk recovery point time.

Optional onPremiseRecoveryPointCount

onPremiseRecoveryPointCount: undefined | number
member

{number} [onPremiseRecoveryPointCount] disk recovery point count.

Optional protectableObjectLoadPath

protectableObjectLoadPath: undefined | object
member

{{ [propertyName: string]: string }} [protectableObjectLoadPath] Attribute to provide information on various DBs.

Optional protectedProperty

protectedProperty: undefined | false | true
member

{boolean} [protectedProperty] To check if backup item is disk protected.

Optional protectionGroupName

protectionGroupName: undefined | string
member

{string} [protectionGroupName] Protection group name of the backup item.

Optional recoveryPointCount

recoveryPointCount: undefined | number
member

{number} [recoveryPointCount] cloud recovery point count.

serializedName

serializedName: string = "DPMProtectedItemExtendedInfo"

Optional totalDiskStorageSizeInBytes

totalDiskStorageSizeInBytes: undefined | string
member

{string} [totalDiskStorageSizeInBytes] total Disk storage in bytes.

type

type: object

className

className: string = "DPMProtectedItemExtendedInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

diskStorageUsedInBytes

diskStorageUsedInBytes: object

serializedName

serializedName: string = "diskStorageUsedInBytes"

type

type: object

name

name: "String" = "String"

isCollocated

isCollocated: object

serializedName

serializedName: string = "isCollocated"

type

type: object

name

name: "Boolean" = "Boolean"

isPresentOnCloud

isPresentOnCloud: object

serializedName

serializedName: string = "isPresentOnCloud"

type

type: object

name

name: "Boolean" = "Boolean"

lastBackupStatus

lastBackupStatus: object

serializedName

serializedName: string = "lastBackupStatus"

type

type: object

name

name: "String" = "String"

lastRefreshedAt

lastRefreshedAt: object

serializedName

serializedName: string = "lastRefreshedAt"

type

type: object

name

name: "DateTime" = "DateTime"

oldestRecoveryPoint

oldestRecoveryPoint: object

serializedName

serializedName: string = "oldestRecoveryPoint"

type

type: object

name

name: "DateTime" = "DateTime"

onPremiseLatestRecoveryPoint

onPremiseLatestRecoveryPoint: object

serializedName

serializedName: string = "onPremiseLatestRecoveryPoint"

type

type: object

name

name: "DateTime" = "DateTime"

onPremiseOldestRecoveryPoint

onPremiseOldestRecoveryPoint: object

serializedName

serializedName: string = "onPremiseOldestRecoveryPoint"

type

type: object

name

name: "DateTime" = "DateTime"

onPremiseRecoveryPointCount

onPremiseRecoveryPointCount: object

serializedName

serializedName: string = "onPremiseRecoveryPointCount"

type

type: object

name

name: "Number" = "Number"

protectableObjectLoadPath

protectableObjectLoadPath: object

serializedName

serializedName: string = "protectableObjectLoadPath"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

protectedProperty

protectedProperty: object

serializedName

serializedName: string = "protected"

type

type: object

name

name: "Boolean" = "Boolean"

protectionGroupName

protectionGroupName: object

serializedName

serializedName: string = "protectionGroupName"

type

type: object

name

name: "String" = "String"

recoveryPointCount

recoveryPointCount: object

serializedName

serializedName: string = "recoveryPointCount"

type

type: object

name

name: "Number" = "Number"

totalDiskStorageSizeInBytes

totalDiskStorageSizeInBytes: object

serializedName

serializedName: string = "totalDiskStorageSizeInBytes"

type

type: object

name

name: "String" = "String"

Const DailyRetentionFormat

DailyRetentionFormat: object
interface

An interface representing DailyRetentionFormat. Daily retention format.

Optional daysOfTheMonth

daysOfTheMonth: Day[]
member

{Day[]} [daysOfTheMonth] List of days of the month.

serializedName

serializedName: string = "DailyRetentionFormat"

type

type: object

className

className: string = "DailyRetentionFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

daysOfTheMonth

daysOfTheMonth: object

serializedName

serializedName: string = "daysOfTheMonth"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Day"

name

name: "Composite" = "Composite"

Const DailyRetentionSchedule

DailyRetentionSchedule: object
interface

An interface representing DailyRetentionSchedule. Daily retention schedule.

Optional retentionDuration

retentionDuration: RetentionDuration
member

{RetentionDuration} [retentionDuration] Retention duration of retention Policy.

Optional retentionTimes

retentionTimes: Date[] | string[]
member

{Date[] | string[]} [retentionTimes] Retention times of retention policy.

serializedName

serializedName: string = "DailyRetentionSchedule"

type

type: object

className

className: string = "DailyRetentionSchedule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

retentionDuration

retentionDuration: object

serializedName

serializedName: string = "retentionDuration"

type

type: object

className

className: string = "RetentionDuration"

name

name: "Composite" = "Composite"

retentionTimes

retentionTimes: object

serializedName

serializedName: string = "retentionTimes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "DateTime" = "DateTime"

Const Day

Day: object
interface

An interface representing Day. Day of the week.

Optional date

date: undefined | number
member

{number} [date] Date of the month

Optional isLast

isLast: undefined | false | true
member

{boolean} [isLast] Whether Date is last date of month

serializedName

serializedName: string = "Day"

type

type: object

className

className: string = "Day"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

date

date: object

serializedName

serializedName: string = "date"

type

type: object

name

name: "Number" = "Number"

isLast

isLast: object

serializedName

serializedName: string = "isLast"

type

type: object

name

name: "Boolean" = "Boolean"

Const DistributedNodesInfo

DistributedNodesInfo: object
interface

An interface representing DistributedNodesInfo. This is used to represent the various nodes of the distributed container.

Optional errorDetail

errorDetail: ErrorDetail
member

{ErrorDetail} [errorDetail] Error Details if the Status is non-success.

Optional nodeName

nodeName: undefined | string
member

{string} [nodeName] Name of the node under a distributed container.

serializedName

serializedName: string = "DistributedNodesInfo"

Optional status

status: undefined | string
member

{string} [status] Status of this Node. Failed | Succeeded

type

type: object

className

className: string = "DistributedNodesInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

errorDetail

errorDetail: object

serializedName

serializedName: string = "errorDetail"

type

type: object

className

className: string = "ErrorDetail"

name

name: "Composite" = "Composite"

nodeName

nodeName: object

serializedName

serializedName: string = "nodeName"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const DpmBackupEngine

DpmBackupEngine: object
interface

An interface representing DpmBackupEngine. Data Protection Manager (DPM) specific backup engine.

Optional azureBackupAgentVersion

azureBackupAgentVersion: undefined | string
member

{string} [azureBackupAgentVersion] Backup agent version

Optional backupEngineId

backupEngineId: undefined | string
member

{string} [backupEngineId] ID of the backup engine.

Optional backupEngineState

backupEngineState: undefined | string
member

{string} [backupEngineState] Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed}

backupEngineType

backupEngineType: "DpmBackupEngine"
member

{string} backupEngineType Polymorphic Discriminator

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup management for the backup engine. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional canReRegister

canReRegister: undefined | false | true
member

{boolean} [canReRegister] Flag indicating if the backup engine be registered, once already registered.

Optional dpmVersion

dpmVersion: undefined | string
member

{string} [dpmVersion] Backup engine version

Optional extendedInfo

extendedInfo: BackupEngineExtendedInfo
member

{BackupEngineExtendedInfo} [extendedInfo] Extended info of the backupengine

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the backup engine.

Optional healthStatus

healthStatus: undefined | string
member

{string} [healthStatus] Backup status of the backup engine.

Optional isAzureBackupAgentUpgradeAvailable

isAzureBackupAgentUpgradeAvailable: undefined | false | true
member

{boolean} [isAzureBackupAgentUpgradeAvailable] To check if backup agent upgrade available

Optional isDpmUpgradeAvailable

isDpmUpgradeAvailable: undefined | false | true
member

{boolean} [isDpmUpgradeAvailable] To check if backup engine upgrade available

Optional registrationStatus

registrationStatus: undefined | string
member

{string} [registrationStatus] Registration status of the backup engine with the Recovery Services Vault.

serializedName

serializedName: string = "DpmBackupEngine"

type

type: object

className

className: string = "DpmBackupEngine"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = BackupEngineBase.type.polymorphicDiscriminator

uberParent

uberParent: string = "BackupEngineBase"

modelProperties

modelProperties: object

Const DpmContainer

DpmContainer: object
interface

An interface representing DpmContainer. DPM workload-specific protection container.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional canReRegister

canReRegister: undefined | false | true
member

{boolean} [canReRegister] Specifies whether the container is re-registrable.

Optional containerId

containerId: undefined | string
member

{string} [containerId] ID of container.

containerType

containerType: "DPMContainer"
member

{string} containerType Polymorphic Discriminator

Optional dpmAgentVersion

dpmAgentVersion: undefined | string
member

{string} [dpmAgentVersion] Backup engine Agent version

Optional dpmServers

dpmServers: string[]
member

{string[]} [dpmServers] List of BackupEngines protecting the container

Optional extendedInfo

extendedInfo: DPMContainerExtendedInfo
member

{DPMContainerExtendedInfo} [extendedInfo] Extended Info of the container.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the container.

Optional healthStatus

healthStatus: undefined | string
member

{string} [healthStatus] Status of health of the container.

Optional protectedItemCount

protectedItemCount: undefined | number
member

{number} [protectedItemCount] Number of protected items in the BackupEngine

Optional protectionStatus

protectionStatus: undefined | string
member

{string} [protectionStatus] Protection status of the container.

Optional registrationStatus

registrationStatus: undefined | string
member

{string} [registrationStatus] Status of registration of the container with the Recovery Services Vault.

serializedName

serializedName: string = "DPMContainer"

Optional upgradeAvailable

upgradeAvailable: undefined | false | true
member

{boolean} [upgradeAvailable] To check if upgrade available

type

type: object

className

className: string = "DpmContainer"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionContainer.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionContainer"

modelProperties

modelProperties: object

canReRegister

canReRegister: object

serializedName

serializedName: string = "canReRegister"

type

type: object

name

name: "Boolean" = "Boolean"

containerId

containerId: object

serializedName

serializedName: string = "containerId"

type

type: object

name

name: "String" = "String"

dpmAgentVersion

dpmAgentVersion: object

serializedName

serializedName: string = "dpmAgentVersion"

type

type: object

name

name: "String" = "String"

dpmServers

dpmServers: object

serializedName

serializedName: string = "dpmServers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

extendedInfo

extendedInfo: object

serializedName

serializedName: string = "extendedInfo"

type

type: object

className

className: string = "DPMContainerExtendedInfo"

name

name: "Composite" = "Composite"

protectedItemCount

protectedItemCount: object

serializedName

serializedName: string = "protectedItemCount"

type

type: object

name

name: "Number" = "Number"

protectionStatus

protectionStatus: object

serializedName

serializedName: string = "protectionStatus"

type

type: object

name

name: "String" = "String"

upgradeAvailable

upgradeAvailable: object

serializedName

serializedName: string = "upgradeAvailable"

type

type: object

name

name: "Boolean" = "Boolean"

Const DpmErrorInfo

DpmErrorInfo: object
interface

An interface representing DpmErrorInfo. DPM workload-specific error information.

Optional errorString

errorString: undefined | string
member

{string} [errorString] Localized error string.

Optional recommendations

recommendations: string[]
member

{string[]} [recommendations] List of localized recommendations for above error code.

serializedName

serializedName: string = "DpmErrorInfo"

type

type: object

className

className: string = "DpmErrorInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

errorString

errorString: object

serializedName

serializedName: string = "errorString"

type

type: object

name

name: "String" = "String"

recommendations

recommendations: object

serializedName

serializedName: string = "recommendations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const DpmJob

DpmJob: object
interface

An interface representing DpmJob. DPM workload-specifc job object.

Optional actionsInfo

actionsInfo: JobSupportedAction[]
member

{JobSupportedAction[]} [actionsInfo] The state/actions applicable on this job like cancel/retry.

Optional activityId

activityId: undefined | string
member

{string} [activityId] ActivityId of job.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Backup management type to execute the current job. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional containerName

containerName: undefined | string
member

{string} [containerName] Name of cluster/server protecting current backup item, if any.

Optional containerType

containerType: undefined | string
member

{string} [containerType] Type of container.

Optional dpmServerName

dpmServerName: undefined | string
member

{string} [dpmServerName] DPM server name managing the backup item or backup job.

Optional duration

duration: undefined | string
member

{string} [duration] Time elapsed for job.

Optional endTime

endTime: Date
member

{Date} [endTime] The end time.

Optional entityFriendlyName

entityFriendlyName: undefined | string
member

{string} [entityFriendlyName] Friendly name of the entity on which the current job is executing.

Optional errorDetails

errorDetails: DpmErrorInfo[]
member

{DpmErrorInfo[]} [errorDetails] The errors.

Optional extendedInfo

extendedInfo: DpmJobExtendedInfo
member

{DpmJobExtendedInfo} [extendedInfo] Additional information for this job.

jobType

jobType: "DpmJob"
member

{string} jobType Polymorphic Discriminator

Optional operation

operation: undefined | string
member

{string} [operation] The operation name.

serializedName

serializedName: string = "DpmJob"

Optional startTime

startTime: Date
member

{Date} [startTime] The start time.

Optional status

status: undefined | string
member

{string} [status] Job status.

Optional workloadType

workloadType: undefined | string
member

{string} [workloadType] Type of backup item.

type

type: object

className

className: string = "DpmJob"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Job.type.polymorphicDiscriminator

uberParent

uberParent: string = "Job"

modelProperties

modelProperties: object

actionsInfo

actionsInfo: object

serializedName

serializedName: string = "actionsInfo"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["Invalid","Cancellable","Retriable"]

name

name: "Enum" = "Enum"

containerName

containerName: object

serializedName

serializedName: string = "containerName"

type

type: object

name

name: "String" = "String"

containerType

containerType: object

serializedName

serializedName: string = "containerType"

type

type: object

name

name: "String" = "String"

dpmServerName

dpmServerName: object

serializedName

serializedName: string = "dpmServerName"

type

type: object

name

name: "String" = "String"

duration

duration: object

serializedName

serializedName: string = "duration"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

errorDetails

errorDetails: object

serializedName

serializedName: string = "errorDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DpmErrorInfo"

name

name: "Composite" = "Composite"

extendedInfo

extendedInfo: object

serializedName

serializedName: string = "extendedInfo"

type

type: object

className

className: string = "DpmJobExtendedInfo"

name

name: "Composite" = "Composite"

workloadType

workloadType: object

serializedName

serializedName: string = "workloadType"

type

type: object

name

name: "String" = "String"

Const DpmJobExtendedInfo

DpmJobExtendedInfo: object
interface

An interface representing DpmJobExtendedInfo. Additional information on the DPM workload-specific job.

Optional dynamicErrorMessage

dynamicErrorMessage: undefined | string
member

{string} [dynamicErrorMessage] Non localized error message on job execution.

Optional propertyBag

propertyBag: undefined | object
member

{{ [propertyName: string]: string }} [propertyBag] The job properties.

serializedName

serializedName: string = "DpmJobExtendedInfo"

Optional tasksList

tasksList: DpmJobTaskDetails[]
member

{DpmJobTaskDetails[]} [tasksList] List of tasks associated with this job.

type

type: object

className

className: string = "DpmJobExtendedInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dynamicErrorMessage

dynamicErrorMessage: object

serializedName

serializedName: string = "dynamicErrorMessage"

type

type: object

name

name: "String" = "String"

propertyBag

propertyBag: object

serializedName

serializedName: string = "propertyBag"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

tasksList

tasksList: object

serializedName

serializedName: string = "tasksList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DpmJobTaskDetails"

name

name: "Composite" = "Composite"

Const DpmJobTaskDetails

DpmJobTaskDetails: object
interface

An interface representing DpmJobTaskDetails. DPM workload-specific job task details.

Optional duration

duration: undefined | string
member

{string} [duration] Time elapsed for task.

Optional endTime

endTime: Date
member

{Date} [endTime] The end time.

serializedName

serializedName: string = "DpmJobTaskDetails"

Optional startTime

startTime: Date
member

{Date} [startTime] The start time.

Optional status

status: undefined | string
member

{string} [status] The status.

Optional taskId

taskId: undefined | string
member

{string} [taskId] The task display name.

type

type: object

className

className: string = "DpmJobTaskDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

duration

duration: object

serializedName

serializedName: string = "duration"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

taskId

taskId: object

serializedName

serializedName: string = "taskId"

type

type: object

name

name: "String" = "String"

Const EncryptionDetails

EncryptionDetails: object
interface

An interface representing EncryptionDetails. Details needed if the VM was encrypted at the time of backup.

Optional encryptionEnabled

encryptionEnabled: undefined | false | true
member

{boolean} [encryptionEnabled] Identifies whether this backup copy represents an encrypted VM at the time of backup.

Optional kekUrl

kekUrl: undefined | string
member

{string} [kekUrl] Key Url.

Optional kekVaultId

kekVaultId: undefined | string
member

{string} [kekVaultId] ID of Key Vault where KEK is stored.

Optional secretKeyUrl

secretKeyUrl: undefined | string
member

{string} [secretKeyUrl] Secret Url.

Optional secretKeyVaultId

secretKeyVaultId: undefined | string
member

{string} [secretKeyVaultId] ID of Key Vault where Secret is stored.

serializedName

serializedName: string = "EncryptionDetails"

type

type: object

className

className: string = "EncryptionDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

encryptionEnabled

encryptionEnabled: object

serializedName

serializedName: string = "encryptionEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

kekUrl

kekUrl: object

serializedName

serializedName: string = "kekUrl"

type

type: object

name

name: "String" = "String"

kekVaultId

kekVaultId: object

serializedName

serializedName: string = "kekVaultId"

type

type: object

name

name: "String" = "String"

secretKeyUrl

secretKeyUrl: object

serializedName

serializedName: string = "secretKeyUrl"

type

type: object

name

name: "String" = "String"

secretKeyVaultId

secretKeyVaultId: object

serializedName

serializedName: string = "secretKeyVaultId"

type

type: object

name

name: "String" = "String"

Const ErrorDetail

ErrorDetail: object
interface

An interface representing ErrorDetail. Error Detail class which encapsulates Code, Message and Recommendations.

Optional code

code: undefined | string
member

{string} [code] Error code.

Optional message

message: undefined | string
member

{string} [message] Error Message related to the Code.

Optional recommendations

recommendations: string[]
member

{string[]} [recommendations] List of recommendation strings.

serializedName

serializedName: string = "ErrorDetail"

type

type: object

className

className: string = "ErrorDetail"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

recommendations

recommendations: object

serializedName

serializedName: string = "recommendations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const ExportJobsOperationResultInfo

ExportJobsOperationResultInfo: object
interface

An interface representing ExportJobsOperationResultInfo. This class is used to send blob details after exporting jobs.

Optional blobSasKey

blobSasKey: undefined | string
member

{string} [blobSasKey] SAS key to access the blob. It expires in 15 mins.

Optional blobUrl

blobUrl: undefined | string
member

{string} [blobUrl] URL of the blob into which the serialized string of list of jobs is exported.

objectType

objectType: "ExportJobsOperationResultInfo"
member

{string} objectType Polymorphic Discriminator

serializedName

serializedName: string = "ExportJobsOperationResultInfo"

type

type: object

className

className: string = "ExportJobsOperationResultInfo"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = OperationResultInfoBase.type.polymorphicDiscriminator

uberParent

uberParent: string = "OperationResultInfoBase"

modelProperties

modelProperties: object

blobSasKey

blobSasKey: object

serializedName

serializedName: string = "blobSasKey"

type

type: object

name

name: "String" = "String"

blobUrl

blobUrl: object

serializedName

serializedName: string = "blobUrl"

type

type: object

name

name: "String" = "String"

Const FeatureSupportRequest

FeatureSupportRequest: object
interface

An interface representing FeatureSupportRequest. Base class for feature request

featureType

featureType: "FeatureSupportRequest"
member

{string} featureType Polymorphic Discriminator

serializedName

serializedName: string = "FeatureSupportRequest"

type

type: object

className

className: string = "FeatureSupportRequest"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "FeatureSupportRequest"

modelProperties

modelProperties: object

featureType

featureType: object

required

required: true = true

serializedName

serializedName: string = "featureType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "featureType"

serializedName

serializedName: string = "featureType"

Const GenericContainer

GenericContainer: object
interface

An interface representing GenericContainer. Base class for generic container of backup items

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

containerType

containerType: "GenericContainer"
member

{string} containerType Polymorphic Discriminator

Optional extendedInformation

extendedInformation: GenericContainerExtendedInfo
member

{GenericContainerExtendedInfo} [extendedInformation] Extended information (not returned in List container API calls)

Optional fabricName

fabricName: undefined | string
member

{string} [fabricName] Name of the container's fabric

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the container.

Optional healthStatus

healthStatus: undefined | string
member

{string} [healthStatus] Status of health of the container.

Optional registrationStatus

registrationStatus: undefined | string
member

{string} [registrationStatus] Status of registration of the container with the Recovery Services Vault.

serializedName

serializedName: string = "GenericContainer"

type

type: object

className

className: string = "GenericContainer"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionContainer.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionContainer"

modelProperties

modelProperties: object

extendedInformation

extendedInformation: object

serializedName

serializedName: string = "extendedInformation"

type

type: object

className

className: string = "GenericContainerExtendedInfo"

name

name: "Composite" = "Composite"

fabricName

fabricName: object

serializedName

serializedName: string = "fabricName"

type

type: object

name

name: "String" = "String"

Const GenericContainerExtendedInfo

GenericContainerExtendedInfo: object
interface

An interface representing GenericContainerExtendedInfo. Container extended information

Optional containerIdentityInfo

containerIdentityInfo: ContainerIdentityInfo
member

{ContainerIdentityInfo} [containerIdentityInfo] Container identity information

Optional rawCertData

rawCertData: undefined | string
member

{string} [rawCertData] Public key of container cert

serializedName

serializedName: string = "GenericContainerExtendedInfo"

Optional serviceEndpoints

serviceEndpoints: undefined | object
member

{{ [propertyName: string]: string }} [serviceEndpoints] Azure Backup Service Endpoints for the container

type

type: object

className

className: string = "GenericContainerExtendedInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containerIdentityInfo

containerIdentityInfo: object

serializedName

serializedName: string = "containerIdentityInfo"

type

type: object

className

className: string = "ContainerIdentityInfo"

name

name: "Composite" = "Composite"

rawCertData

rawCertData: object

serializedName

serializedName: string = "rawCertData"

type

type: object

name

name: "String" = "String"

serviceEndpoints

serviceEndpoints: object

serializedName

serializedName: string = "serviceEndpoints"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const GenericProtectedItem

GenericProtectedItem: object
interface

An interface representing GenericProtectedItem. Base class for backup items.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional backupSetName

backupSetName: undefined | string
member

{string} [backupSetName] Name of the backup set the backup item belongs to

Optional containerName

containerName: undefined | string
member

{string} [containerName] Unique name of container

Optional createMode

createMode: CreateMode
member

{CreateMode} [createMode] Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: 'Invalid', 'Default', 'Recover'

Optional fabricName

fabricName: undefined | string
member

{string} [fabricName] Name of this backup item's fabric.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the container.

Optional lastRecoveryPoint

lastRecoveryPoint: Date
member

{Date} [lastRecoveryPoint] Timestamp when the last (latest) backup copy was created for this backup item.

Optional policyId

policyId: undefined | string
member

{string} [policyId] ID of the backup policy with which this item is backed up.

Optional policyState

policyState: undefined | string
member

{string} [policyState] Indicates consistency of policy object and policy applied to this backup item.

Optional protectedItemId

protectedItemId: undefined | number
member

{number} [protectedItemId] Data Plane Service ID of the protected item.

protectedItemType

protectedItemType: "GenericProtectedItem"
member

{string} protectedItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionState
member

{ProtectionState} [protectionState] Backup state of this backup item. Possible values include: 'Invalid', 'IRPending', 'Protected', 'ProtectionError', 'ProtectionStopped', 'ProtectionPaused'

serializedName

serializedName: string = "GenericProtectedItem"

Optional sourceAssociations

sourceAssociations: undefined | object
member

{{ [propertyName: string]: string }} [sourceAssociations] Loosely coupled (type, value) associations (example - parent of a protected item)

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] ARM ID of the resource to be backed up.

Optional workloadType

workloadType: DataSourceType
member

{DataSourceType} [workloadType] Type of workload this item represents. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

type

type: object

className

className: string = "GenericProtectedItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectedItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectedItem"

modelProperties

modelProperties: object

fabricName

fabricName: object

serializedName

serializedName: string = "fabricName"

type

type: object

name

name: "String" = "String"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

policyState

policyState: object

serializedName

serializedName: string = "policyState"

type

type: object

name

name: "String" = "String"

protectedItemId

protectedItemId: object

serializedName

serializedName: string = "protectedItemId"

type

type: object

name

name: "Number" = "Number"

protectionState

protectionState: object

serializedName

serializedName: string = "protectionState"

type

type: object

name

name: "String" = "String"

sourceAssociations

sourceAssociations: object

serializedName

serializedName: string = "sourceAssociations"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const GenericProtectionPolicy

GenericProtectionPolicy: object
interface

An interface representing GenericProtectionPolicy. Azure VM (Mercury) workload-specific backup policy.

backupManagementType

backupManagementType: "GenericProtectionPolicy"
member

{string} backupManagementType Polymorphic Discriminator

Optional fabricName

fabricName: undefined | string
member

{string} [fabricName] Name of this policy's fabric.

Optional protectedItemsCount

protectedItemsCount: undefined | number
member

{number} [protectedItemsCount] Number of items associated with this policy.

serializedName

serializedName: string = "GenericProtectionPolicy"

Optional subProtectionPolicy

subProtectionPolicy: SubProtectionPolicy[]
member

{SubProtectionPolicy[]} [subProtectionPolicy] List of sub-protection policies which includes schedule and retention

Optional timeZone

timeZone: undefined | string
member

{string} [timeZone] TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time".

type

type: object

className

className: string = "GenericProtectionPolicy"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionPolicy.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionPolicy"

modelProperties

modelProperties: object

fabricName

fabricName: object

serializedName

serializedName: string = "fabricName"

type

type: object

name

name: "String" = "String"

subProtectionPolicy

subProtectionPolicy: object

serializedName

serializedName: string = "subProtectionPolicy"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SubProtectionPolicy"

name

name: "Composite" = "Composite"

timeZone

timeZone: object

serializedName

serializedName: string = "timeZone"

type

type: object

name

name: "String" = "String"

Const GenericRecoveryPoint

GenericRecoveryPoint: object
interface

An interface representing GenericRecoveryPoint. Generic backup copy.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the backup copy.

objectType

objectType: "GenericRecoveryPoint"
member

{string} objectType Polymorphic Discriminator

Optional recoveryPointAdditionalInfo

recoveryPointAdditionalInfo: undefined | string
member

{string} [recoveryPointAdditionalInfo] Additional information associated with this backup copy.

Optional recoveryPointTime

recoveryPointTime: Date
member

{Date} [recoveryPointTime] Time at which this backup copy was created.

Optional recoveryPointType

recoveryPointType: undefined | string
member

{string} [recoveryPointType] Type of the backup copy.

serializedName

serializedName: string = "GenericRecoveryPoint"

type

type: object

className

className: string = "GenericRecoveryPoint"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RecoveryPoint.type.polymorphicDiscriminator

uberParent

uberParent: string = "RecoveryPoint"

modelProperties

modelProperties: object

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

recoveryPointAdditionalInfo

recoveryPointAdditionalInfo: object

serializedName

serializedName: string = "recoveryPointAdditionalInfo"

type

type: object

name

name: "String" = "String"

recoveryPointTime

recoveryPointTime: object

serializedName

serializedName: string = "recoveryPointTime"

type

type: object

name

name: "DateTime" = "DateTime"

recoveryPointType

recoveryPointType: object

serializedName

serializedName: string = "recoveryPointType"

type

type: object

name

name: "String" = "String"

Const GetProtectedItemQueryObject

GetProtectedItemQueryObject: object
interface

An interface representing GetProtectedItemQueryObject. Filters to list backup items.

Optional expand

expand: undefined | string
member

{string} [expand] Specifies if the additional information should be provided for this item.

serializedName

serializedName: string = "GetProtectedItemQueryObject"

type

type: object

className

className: string = "GetProtectedItemQueryObject"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

expand

expand: object

serializedName

serializedName: string = "expand"

type

type: object

name

name: "String" = "String"

Const ILRRequest

ILRRequest: object
interface

An interface representing ILRRequest. Parameters to restore file/folders API.

objectType

objectType: "ILRRequest"
member

{string} objectType Polymorphic Discriminator

serializedName

serializedName: string = "ILRRequest"

type

type: object

className

className: string = "ILRRequest"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ILRRequest"

modelProperties

modelProperties: object

objectType

objectType: object

required

required: true = true

serializedName

serializedName: string = "objectType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "objectType"

serializedName

serializedName: string = "objectType"

Const ILRRequestResource

ILRRequestResource: object
interface

An interface representing ILRRequestResource. Parameters to restore file/folders API.

extends

Resource

Optional eTag

eTag: undefined | string
member

{string} [eTag] Optional ETag.

Optional id

id: undefined | string
member

{string} [id] Resource Id represents the complete path to the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource location.

Optional name

name: undefined | string
member

{string} [name] Resource name associated with the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: ILRRequestUnion
member

{ILRRequestUnion} [properties] ILRRequestResource properties

serializedName

serializedName: string = "ILRRequestResource"

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

type

type: object

className

className: string = "ILRRequestResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "ILRRequest"

name

name: "Composite" = "Composite"

Const IaaSVMContainer

IaaSVMContainer: object
interface

An interface representing IaaSVMContainer. IaaS VM workload-specific container.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

containerType

containerType: "IaaSVMContainer"
member

{string} containerType Polymorphic Discriminator

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the container.

Optional healthStatus

healthStatus: undefined | string
member

{string} [healthStatus] Status of health of the container.

Optional registrationStatus

registrationStatus: undefined | string
member

{string} [registrationStatus] Status of registration of the container with the Recovery Services Vault.

Optional resourceGroup

resourceGroup: undefined | string
member

{string} [resourceGroup] Resource group name of Recovery Services Vault.

serializedName

serializedName: string = "IaaSVMContainer"

Optional virtualMachineId

virtualMachineId: undefined | string
member

{string} [virtualMachineId] Fully qualified ARM url of the virtual machine represented by this Azure IaaS VM container.

Optional virtualMachineVersion

virtualMachineVersion: undefined | string
member

{string} [virtualMachineVersion] Specifies whether the container represents a Classic or an Azure Resource Manager VM.

type

type: object

className

className: string = "IaaSVMContainer"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionContainer.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionContainer"

modelProperties

modelProperties: object

resourceGroup

resourceGroup: object

serializedName

serializedName: string = "resourceGroup"

type

type: object

name

name: "String" = "String"

virtualMachineId

virtualMachineId: object

serializedName

serializedName: string = "virtualMachineId"

type

type: object

name

name: "String" = "String"

virtualMachineVersion

virtualMachineVersion: object

serializedName

serializedName: string = "virtualMachineVersion"

type

type: object

name

name: "String" = "String"

Const IaaSVMProtectableItem

IaaSVMProtectableItem: object
interface

An interface representing IaaSVMProtectableItem. IaaS VM workload-specific backup item.

Optional backupManagementType

backupManagementType: undefined | string
member

{string} [backupManagementType] Type of backup managemenent to backup an item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the backup item.

protectableItemType

protectableItemType: "IaaSVMProtectableItem"
member

{string} protectableItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionStatus
member

{ProtectionStatus} [protectionState] State of the back up item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "IaaSVMProtectableItem"

Optional virtualMachineId

virtualMachineId: undefined | string
member

{string} [virtualMachineId] Fully qualified ARM ID of the virtual machine.

Optional workloadType

workloadType: undefined | string
member

{string} [workloadType] Type of workload for the backup management

type

type: object

className

className: string = "IaaSVMProtectableItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = WorkloadProtectableItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "WorkloadProtectableItem"

modelProperties

modelProperties: object

virtualMachineId

virtualMachineId: object

serializedName

serializedName: string = "virtualMachineId"

type

type: object

name

name: "String" = "String"

Const IaasVMBackupRequest

IaasVMBackupRequest: object
interface

An interface representing IaasVMBackupRequest. IaaS VM workload-specific backup request.

objectType

objectType: "IaasVMBackupRequest"
member

{string} objectType Polymorphic Discriminator

Optional recoveryPointExpiryTimeInUTC

recoveryPointExpiryTimeInUTC: Date
member

{Date} [recoveryPointExpiryTimeInUTC] Backup copy will expire after the time specified (UTC).

serializedName

serializedName: string = "IaasVMBackupRequest"

type

type: object

className

className: string = "IaasVMBackupRequest"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = BackupRequest.type.polymorphicDiscriminator

uberParent

uberParent: string = "BackupRequest"

modelProperties

modelProperties: object

recoveryPointExpiryTimeInUTC

recoveryPointExpiryTimeInUTC: object

serializedName

serializedName: string = "recoveryPointExpiryTimeInUTC"

type

type: object

name

name: "DateTime" = "DateTime"

Const IaasVMILRRegistrationRequest

IaasVMILRRegistrationRequest: object
interface

An interface representing IaasVMILRRegistrationRequest. Restore files/folders from a backup copy of IaaS VM.

Optional initiatorName

initiatorName: undefined | string
member

{string} [initiatorName] iSCSI initiator name.

objectType

objectType: "IaasVMILRRegistrationRequest"
member

{string} objectType Polymorphic Discriminator

Optional recoveryPointId

recoveryPointId: undefined | string
member

{string} [recoveryPointId] ID of the IaaS VM backup copy from where the files/folders have to be restored.

Optional renewExistingRegistration

renewExistingRegistration: undefined | false | true
member

{boolean} [renewExistingRegistration] Whether to renew existing registration with the iSCSI server.

serializedName

serializedName: string = "IaasVMILRRegistrationRequest"

Optional virtualMachineId

virtualMachineId: undefined | string
member

{string} [virtualMachineId] Fully qualified ARM ID of the virtual machine whose the files / folders have to be restored.

type

type: object

className

className: string = "IaasVMILRRegistrationRequest"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ILRRequest.type.polymorphicDiscriminator

uberParent

uberParent: string = "ILRRequest"

modelProperties

modelProperties: object

initiatorName

initiatorName: object

serializedName

serializedName: string = "initiatorName"

type

type: object

name

name: "String" = "String"

recoveryPointId

recoveryPointId: object

serializedName

serializedName: string = "recoveryPointId"

type

type: object

name

name: "String" = "String"

renewExistingRegistration

renewExistingRegistration: object

serializedName

serializedName: string = "renewExistingRegistration"

type

type: object

name

name: "Boolean" = "Boolean"

virtualMachineId

virtualMachineId: object

serializedName

serializedName: string = "virtualMachineId"

type

type: object

name

name: "String" = "String"

Const IaasVMRecoveryPoint

IaasVMRecoveryPoint: object
interface

An interface representing IaasVMRecoveryPoint. IaaS VM workload specific backup copy.

Optional isInstantIlrSessionActive

isInstantIlrSessionActive: undefined | false | true
member

{boolean} [isInstantIlrSessionActive] Is the session to recover items from this backup copy still active.

Optional isManagedVirtualMachine

isManagedVirtualMachine: undefined | false | true
member

{boolean} [isManagedVirtualMachine] Whether VM is with Managed Disks

Optional isSourceVMEncrypted

isSourceVMEncrypted: undefined | false | true
member

{boolean} [isSourceVMEncrypted] Identifies whether the VM was encrypted when the backup copy is created.

Optional keyAndSecret

keyAndSecret: KeyAndSecretDetails
member

{KeyAndSecretDetails} [keyAndSecret] Required details for recovering an encrypted VM. Applicable only when IsSourceVMEncrypted is true.

objectType

objectType: "IaasVMRecoveryPoint"
member

{string} objectType Polymorphic Discriminator

Optional originalStorageAccountOption

originalStorageAccountOption: undefined | false | true
member

{boolean} [originalStorageAccountOption] Original Storage Account Option

Optional osType

osType: undefined | string
member

{string} [osType] OS type

Optional recoveryPointAdditionalInfo

recoveryPointAdditionalInfo: undefined | string
member

{string} [recoveryPointAdditionalInfo] Additional information associated with this backup copy.

Optional recoveryPointTierDetails

recoveryPointTierDetails: RecoveryPointTierInformation[]
member

{RecoveryPointTierInformation[]} [recoveryPointTierDetails] Recovery point tier information.

Optional recoveryPointTime

recoveryPointTime: Date
member

{Date} [recoveryPointTime] Time at which this backup copy was created.

Optional recoveryPointType

recoveryPointType: undefined | string
member

{string} [recoveryPointType] Type of the backup copy.

serializedName

serializedName: string = "IaasVMRecoveryPoint"

Optional sourceVMStorageType

sourceVMStorageType: undefined | string
member

{string} [sourceVMStorageType] Storage type of the VM whose backup copy is created.

Optional virtualMachineSize

virtualMachineSize: undefined | string
member

{string} [virtualMachineSize] Virtual Machine Size

type

type: object

className

className: string = "IaasVMRecoveryPoint"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RecoveryPoint.type.polymorphicDiscriminator

uberParent

uberParent: string = "RecoveryPoint"

modelProperties

modelProperties: object

isInstantIlrSessionActive

isInstantIlrSessionActive: object

serializedName

serializedName: string = "isInstantIlrSessionActive"

type

type: object

name

name: "Boolean" = "Boolean"

isManagedVirtualMachine

isManagedVirtualMachine: object

serializedName

serializedName: string = "isManagedVirtualMachine"

type

type: object

name

name: "Boolean" = "Boolean"

isSourceVMEncrypted

isSourceVMEncrypted: object

serializedName

serializedName: string = "isSourceVMEncrypted"

type

type: object

name

name: "Boolean" = "Boolean"

keyAndSecret

keyAndSecret: object

serializedName

serializedName: string = "keyAndSecret"

type

type: object

className

className: string = "KeyAndSecretDetails"

name

name: "Composite" = "Composite"

originalStorageAccountOption

originalStorageAccountOption: object

serializedName

serializedName: string = "originalStorageAccountOption"

type

type: object

name

name: "Boolean" = "Boolean"

osType

osType: object

serializedName

serializedName: string = "osType"

type

type: object

name

name: "String" = "String"

recoveryPointAdditionalInfo

recoveryPointAdditionalInfo: object

serializedName

serializedName: string = "recoveryPointAdditionalInfo"

type

type: object

name

name: "String" = "String"

recoveryPointTierDetails

recoveryPointTierDetails: object

serializedName

serializedName: string = "recoveryPointTierDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecoveryPointTierInformation"

name

name: "Composite" = "Composite"

recoveryPointTime

recoveryPointTime: object

serializedName

serializedName: string = "recoveryPointTime"

type

type: object

name

name: "DateTime" = "DateTime"

recoveryPointType

recoveryPointType: object

serializedName

serializedName: string = "recoveryPointType"

type

type: object

name

name: "String" = "String"

sourceVMStorageType

sourceVMStorageType: object

serializedName

serializedName: string = "sourceVMStorageType"

type

type: object

name

name: "String" = "String"

virtualMachineSize

virtualMachineSize: object

serializedName

serializedName: string = "virtualMachineSize"

type

type: object

name

name: "String" = "String"

Const IaasVMRestoreRequest

IaasVMRestoreRequest: object
interface

An interface representing IaasVMRestoreRequest. IaaS VM workload-specific restore.

Optional affinityGroup

affinityGroup: undefined | string
member

{string} [affinityGroup] Affinity group associated to VM to be restored. Used only for Classic Compute Virtual Machines.

Optional createNewCloudService

createNewCloudService: undefined | false | true
member

{boolean} [createNewCloudService] Should a new cloud service be created while restoring the VM. If this is false, VM will be restored to the same cloud service as it was at the time of backup.

Optional encryptionDetails

encryptionDetails: EncryptionDetails
member

{EncryptionDetails} [encryptionDetails] Details needed if the VM was encrypted at the time of backup.

objectType

objectType: "IaasVMRestoreRequest"
member

{string} objectType Polymorphic Discriminator

Optional originalStorageAccountOption

originalStorageAccountOption: undefined | false | true
member

{boolean} [originalStorageAccountOption] Original Storage Account Option

Optional recoveryPointId

recoveryPointId: undefined | string
member

{string} [recoveryPointId] ID of the backup copy to be recovered.

Optional recoveryType

recoveryType: RecoveryType
member

{RecoveryType} [recoveryType] Type of this recovery. Possible values include: 'Invalid', 'OriginalLocation', 'AlternateLocation', 'RestoreDisks'

Optional region

region: undefined | string
member

{string} [region] Region in which the virtual machine is restored.

serializedName

serializedName: string = "IaasVMRestoreRequest"

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] Fully qualified ARM ID of the VM which is being recovered.

Optional storageAccountId

storageAccountId: undefined | string
member

{string} [storageAccountId] Fully qualified ARM ID of the storage account to which the VM has to be restored.

Optional subnetId

subnetId: undefined | string
member

{string} [subnetId] Subnet ID, is the subnet ID associated with the to be restored VM. For Classic VMs it would be {VnetID}/Subnet/{SubnetName} and, for the Azure Resource Manager VMs it would be ARM resource ID used to represent the subnet.

Optional targetDomainNameId

targetDomainNameId: undefined | string
member

{string} [targetDomainNameId] Fully qualified ARM ID of the domain name to be associated to the VM being restored. This applies only to Classic Virtual Machines.

Optional targetResourceGroupId

targetResourceGroupId: undefined | string
member

{string} [targetResourceGroupId] This is the ARM Id of the resource group that you want to create for this Virtual machine and other artifacts. For e.g. /subscriptions/{subId}/resourcegroups/{rg}

Optional targetVirtualMachineId

targetVirtualMachineId: undefined | string
member

{string} [targetVirtualMachineId] This is the complete ARM Id of the VM that will be created. For e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}

Optional virtualNetworkId

virtualNetworkId: undefined | string
member

{string} [virtualNetworkId] This is the virtual network Id of the vnet that will be attached to the virtual machine. User will be validated for join action permissions in the linked access.

type

type: object

className

className: string = "IaasVMRestoreRequest"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RestoreRequest.type.polymorphicDiscriminator

uberParent

uberParent: string = "RestoreRequest"

modelProperties

modelProperties: object

affinityGroup

affinityGroup: object

serializedName

serializedName: string = "affinityGroup"

type

type: object

name

name: "String" = "String"

createNewCloudService

createNewCloudService: object

serializedName

serializedName: string = "createNewCloudService"

type

type: object

name

name: "Boolean" = "Boolean"

encryptionDetails

encryptionDetails: object

serializedName

serializedName: string = "encryptionDetails"

type

type: object

className

className: string = "EncryptionDetails"

name

name: "Composite" = "Composite"

originalStorageAccountOption

originalStorageAccountOption: object

serializedName

serializedName: string = "originalStorageAccountOption"

type

type: object

name

name: "Boolean" = "Boolean"

recoveryPointId

recoveryPointId: object

serializedName

serializedName: string = "recoveryPointId"

type

type: object

name

name: "String" = "String"

recoveryType

recoveryType: object

serializedName

serializedName: string = "recoveryType"

type

type: object

name

name: "String" = "String"

region

region: object

serializedName

serializedName: string = "region"

type

type: object

name

name: "String" = "String"

sourceResourceId

sourceResourceId: object

serializedName

serializedName: string = "sourceResourceId"

type

type: object

name

name: "String" = "String"

storageAccountId

storageAccountId: object

serializedName

serializedName: string = "storageAccountId"

type

type: object

name

name: "String" = "String"

subnetId

subnetId: object

serializedName

serializedName: string = "subnetId"

type

type: object

name

name: "String" = "String"

targetDomainNameId

targetDomainNameId: object

serializedName

serializedName: string = "targetDomainNameId"

type

type: object

name

name: "String" = "String"

targetResourceGroupId

targetResourceGroupId: object

serializedName

serializedName: string = "targetResourceGroupId"

type

type: object

name

name: "String" = "String"

targetVirtualMachineId

targetVirtualMachineId: object

serializedName

serializedName: string = "targetVirtualMachineId"

type

type: object

name

name: "String" = "String"

virtualNetworkId

virtualNetworkId: object

serializedName

serializedName: string = "virtualNetworkId"

type

type: object

name

name: "String" = "String"

Const InquiryInfo

InquiryInfo: object
interface

An interface representing InquiryInfo. Details about inquired protectable items under a given container.

Optional errorDetail

errorDetail: ErrorDetail
member

{ErrorDetail} [errorDetail] Error Details if the Status is non-success.

Optional inquiryDetails

inquiryDetails: WorkloadInquiryDetails[]
member

{WorkloadInquiryDetails[]} [inquiryDetails] Inquiry Details which will have workload specific details. For e.g. - For SQL and oracle this will contain different details.

serializedName

serializedName: string = "InquiryInfo"

Optional status

status: undefined | string
member

{string} [status] Inquiry Status for this container such as InProgress | Failed | Succeeded

type

type: object

className

className: string = "InquiryInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

errorDetail

errorDetail: object

serializedName

serializedName: string = "errorDetail"

type

type: object

className

className: string = "ErrorDetail"

name

name: "Composite" = "Composite"

inquiryDetails

inquiryDetails: object

serializedName

serializedName: string = "inquiryDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "WorkloadInquiryDetails"

name

name: "Composite" = "Composite"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const InquiryValidation

InquiryValidation: object
interface

An interface representing InquiryValidation. Validation for inquired protectable items under a given container.

Optional errorDetail

errorDetail: ErrorDetail
member

{ErrorDetail} [errorDetail] Error Detail in case the status is non-success.

serializedName

serializedName: string = "InquiryValidation"

Optional status

status: undefined | string
member

{string} [status] Status for the Inquiry Validation.

type

type: object

className

className: string = "InquiryValidation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

errorDetail

errorDetail: object

serializedName

serializedName: string = "errorDetail"

type

type: object

className

className: string = "ErrorDetail"

name

name: "Composite" = "Composite"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const InstantItemRecoveryTarget

InstantItemRecoveryTarget: object
interface

An interface representing InstantItemRecoveryTarget. Target details for file / folder restore.

Optional clientScripts

clientScripts: ClientScriptForConnect[]
member

{ClientScriptForConnect[]} [clientScripts] List of client scripts.

serializedName

serializedName: string = "InstantItemRecoveryTarget"

type

type: object

className

className: string = "InstantItemRecoveryTarget"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientScripts

clientScripts: object

serializedName

serializedName: string = "clientScripts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ClientScriptForConnect"

name

name: "Composite" = "Composite"

Const Job

Job: object
interface

An interface representing Job. Defines workload agnostic properties for a job.

Optional activityId

activityId: undefined | string
member

{string} [activityId] ActivityId of job.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Backup management type to execute the current job. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional endTime

endTime: Date
member

{Date} [endTime] The end time.

Optional entityFriendlyName

entityFriendlyName: undefined | string
member

{string} [entityFriendlyName] Friendly name of the entity on which the current job is executing.

jobType

jobType: "Job"
member

{string} jobType Polymorphic Discriminator

Optional operation

operation: undefined | string
member

{string} [operation] The operation name.

serializedName

serializedName: string = "Job"

Optional startTime

startTime: Date
member

{Date} [startTime] The start time.

Optional status

status: undefined | string
member

{string} [status] Job status.

type

type: object

className

className: string = "Job"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "Job"

modelProperties

modelProperties: object

activityId

activityId: object

serializedName

serializedName: string = "activityId"

type

type: object

name

name: "String" = "String"

backupManagementType

backupManagementType: object

serializedName

serializedName: string = "backupManagementType"

type

type: object

name

name: "String" = "String"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

entityFriendlyName

entityFriendlyName: object

serializedName

serializedName: string = "entityFriendlyName"

type

type: object

name

name: "String" = "String"

jobType

jobType: object

required

required: true = true

serializedName

serializedName: string = "jobType"

type

type: object

name

name: "String" = "String"

operation

operation: object

serializedName

serializedName: string = "operation"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "jobType"

serializedName

serializedName: string = "jobType"

Const JobQueryObject

JobQueryObject: object
interface

An interface representing JobQueryObject. Filters to list the jobs.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managmenent for the job. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional endTime

endTime: Date
member

{Date} [endTime] Job has ended at this time. Value is in UTC.

Optional jobId

jobId: undefined | string
member

{string} [jobId] JobID represents the job uniquely.

Optional operation

operation: JobOperationType
member

{JobOperationType} [operation] Type of operation. Possible values include: 'Invalid', 'Register', 'UnRegister', 'ConfigureBackup', 'Backup', 'Restore', 'DisableBackup', 'DeleteBackupData'

serializedName

serializedName: string = "JobQueryObject"

Optional startTime

startTime: Date
member

{Date} [startTime] Job has started at this time. Value is in UTC.

Optional status

status: JobStatus
member

{JobStatus} [status] Status of the job. Possible values include: 'Invalid', 'InProgress', 'Completed', 'Failed', 'CompletedWithWarnings', 'Cancelled', 'Cancelling'

type

type: object

className

className: string = "JobQueryObject"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupManagementType

backupManagementType: object

serializedName

serializedName: string = "backupManagementType"

type

type: object

name

name: "String" = "String"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

jobId

jobId: object

serializedName

serializedName: string = "jobId"

type

type: object

name

name: "String" = "String"

operation

operation: object

serializedName

serializedName: string = "operation"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const JobResource

JobResource: object
interface

An interface representing JobResource. Defines workload agnostic properties for a job.

extends

Resource

Optional eTag

eTag: undefined | string
member

{string} [eTag] Optional ETag.

Optional id

id: undefined | string
member

{string} [id] Resource Id represents the complete path to the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource location.

Optional name

name: undefined | string
member

{string} [name] Resource name associated with the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: JobUnion
member

{JobUnion} [properties] JobResource properties

serializedName

serializedName: string = "JobResource"

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

type

type: object

className

className: string = "JobResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "Job"

name

name: "Composite" = "Composite"

Const JobResourceList

JobResourceList: object
interface

An interface representing the JobResourceList. List of Job resources

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "JobResourceList"

__@iterator

  • __@iterator(): IterableIterator<JobResource>

  • Iterator

    Returns IterableIterator<JobResource>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<JobResource>[]): JobResource[]
  • concat(...items: (T | ConcatArray<T>)[]): JobResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<JobResource>[]

      Additional items to add to the end of array1.

    Returns JobResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns JobResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, JobResource]>

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, JobResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: JobResource, index: number, array: JobResource[]): boolean

        • Parameters

          • value: JobResource
          • index: number
          • array: JobResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: JobResource, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: JobResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): JobResource[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: JobResource

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: JobResource, index: number, array: JobResource[]): boolean

        • Parameters

          • value: JobResource
          • index: number
          • array: JobResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: JobResource, index: number, array: JobResource[]): any

        • Parameters

          • value: JobResource
          • index: number
          • array: JobResource[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns JobResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): JobResource | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: JobResource

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: JobResource, index: number, obj: JobResource[]): boolean

        • Parameters

          • this: void
          • value: JobResource
          • index: number
          • obj: JobResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: JobResource, index: number, obj: JobResource[]): boolean

        • Parameters

          • value: JobResource
          • index: number
          • obj: JobResource[]

          Returns boolean

    • Optional thisArg: any

    Returns JobResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: JobResource, index: number, obj: JobResource[]): boolean

        • Parameters

          • value: JobResource
          • index: number
          • obj: JobResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: JobResource, index: number, array: JobResource[]): void

        • Parameters

          • value: JobResource
          • index: number
          • array: JobResource[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: JobResource, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: JobResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: JobResource, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: JobResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: JobResource, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: JobResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: JobResource, index: number, array: JobResource[]): U

        • Parameters

          • value: JobResource
          • index: number
          • array: JobResource[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): JobResource | undefined

  • Removes the last element from an array and returns it.

    Returns JobResource | undefined

push

  • push(...items: JobResource[]): number

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: JobResource[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): JobResource
  • reduce(callbackfn: function, initialValue: JobResource): JobResource
  • reduce<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: JobResource, currentValue: JobResource, currentIndex: number, array: JobResource[]): JobResource

        • Parameters

          • previousValue: JobResource
          • currentValue: JobResource
          • currentIndex: number
          • array: JobResource[]

          Returns JobResource

    Returns JobResource

  • Parameters

    • callbackfn: function
        • (previousValue: JobResource, currentValue: JobResource, currentIndex: number, array: JobResource[]): JobResource

        • Parameters

          • previousValue: JobResource
          • currentValue: JobResource
          • currentIndex: number
          • array: JobResource[]

          Returns JobResource

    • initialValue: JobResource

    Returns JobResource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: JobResource, currentIndex: number, array: JobResource[]): U

        • Parameters

          • previousValue: U
          • currentValue: JobResource
          • currentIndex: number
          • array: JobResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): JobResource
  • reduceRight(callbackfn: function, initialValue: JobResource): JobResource
  • reduceRight<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: JobResource, currentValue: JobResource, currentIndex: number, array: JobResource[]): JobResource

        • Parameters

          • previousValue: JobResource
          • currentValue: JobResource
          • currentIndex: number
          • array: JobResource[]

          Returns JobResource

    Returns JobResource

  • Parameters

    • callbackfn: function
        • (previousValue: JobResource, currentValue: JobResource, currentIndex: number, array: JobResource[]): JobResource

        • Parameters

          • previousValue: JobResource
          • currentValue: JobResource
          • currentIndex: number
          • array: JobResource[]

          Returns JobResource

    • initialValue: JobResource

    Returns JobResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: JobResource, currentIndex: number, array: JobResource[]): U

        • Parameters

          • previousValue: U
          • currentValue: JobResource
          • currentIndex: number
          • array: JobResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): JobResource[]

  • Reverses the elements in an Array.

    Returns JobResource[]

shift

  • shift(): JobResource | undefined

  • Removes the first element from an array and returns it.

    Returns JobResource | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): JobResource[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns JobResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: JobResource, index: number, array: JobResource[]): boolean

        • Parameters

          • value: JobResource
          • index: number
          • array: JobResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): JobResource[]
  • splice(start: number, deleteCount: number, ...items: JobResource[]): JobResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns JobResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: JobResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns JobResource[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: JobResource[]): number

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: JobResource[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<JobResource>

  • Returns an iterable of values in the array

    Returns IterableIterator<JobResource>

type

type: object

className

className: string = "JobResourceList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "JobResource"

name

name: "Composite" = "Composite"

Const KEKDetails

KEKDetails: object
interface

An interface representing KEKDetails. KEK is encryption key for BEK.

Optional keyBackupData

keyBackupData: undefined | string
member

{string} [keyBackupData] KEK data.

Optional keyUrl

keyUrl: undefined | string
member

{string} [keyUrl] Key is KEK.

Optional keyVaultId

keyVaultId: undefined | string
member

{string} [keyVaultId] Key Vault ID where this Key is stored.

serializedName

serializedName: string = "KEKDetails"

type

type: object

className

className: string = "KEKDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

keyBackupData

keyBackupData: object

serializedName

serializedName: string = "keyBackupData"

type

type: object

name

name: "String" = "String"

keyUrl

keyUrl: object

serializedName

serializedName: string = "keyUrl"

type

type: object

name

name: "String" = "String"

keyVaultId

keyVaultId: object

serializedName

serializedName: string = "keyVaultId"

type

type: object

name

name: "String" = "String"

Const KeyAndSecretDetails

KeyAndSecretDetails: object
interface

An interface representing KeyAndSecretDetails. BEK is bitlocker key. KEK is encryption key for BEK If the VM was encrypted then we will store follwing details :

  1. Secret(BEK) - Url + Backup Data + vaultId.
  2. Key(KEK) - Url + Backup Data + vaultId.
  3. EncryptionMechanism BEK and KEK can potentiallty have different vault ids.

Optional bekDetails

bekDetails: BEKDetails
member

{BEKDetails} [bekDetails] BEK is bitlocker encrpytion key.

Optional encryptionMechanism

encryptionMechanism: undefined | string
member

{string} [encryptionMechanism] Encryption mechanism: None/ SinglePass/ DoublePass

Optional kekDetails

kekDetails: KEKDetails
member

{KEKDetails} [kekDetails] KEK is encryption key for BEK.

serializedName

serializedName: string = "KeyAndSecretDetails"

type

type: object

className

className: string = "KeyAndSecretDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

bekDetails

bekDetails: object

serializedName

serializedName: string = "bekDetails"

type

type: object

className

className: string = "BEKDetails"

name

name: "Composite" = "Composite"

encryptionMechanism

encryptionMechanism: object

serializedName

serializedName: string = "encryptionMechanism"

type

type: object

name

name: "String" = "String"

kekDetails

kekDetails: object

serializedName

serializedName: string = "kekDetails"

type

type: object

className

className: string = "KEKDetails"

name

name: "Composite" = "Composite"

Const LogSchedulePolicy

LogSchedulePolicy: object
interface

An interface representing LogSchedulePolicy. Log policy schedule.

Optional scheduleFrequencyInMins

scheduleFrequencyInMins: undefined | number
member

{number} [scheduleFrequencyInMins] Frequency of the log schedule operation of this policy in minutes.

schedulePolicyType

schedulePolicyType: "LogSchedulePolicy"
member

{string} schedulePolicyType Polymorphic Discriminator

serializedName

serializedName: string = "LogSchedulePolicy"

type

type: object

className

className: string = "LogSchedulePolicy"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = SchedulePolicy.type.polymorphicDiscriminator

uberParent

uberParent: string = "SchedulePolicy"

modelProperties

modelProperties: object

scheduleFrequencyInMins

scheduleFrequencyInMins: object

serializedName

serializedName: string = "scheduleFrequencyInMins"

type

type: object

name

name: "Number" = "Number"

Const LongTermRetentionPolicy

LongTermRetentionPolicy: object
interface

An interface representing LongTermRetentionPolicy. Long term retention policy.

Optional dailySchedule

dailySchedule: DailyRetentionSchedule
member

{DailyRetentionSchedule} [dailySchedule] Daily retention schedule of the protection policy.

Optional monthlySchedule

monthlySchedule: MonthlyRetentionSchedule
member

{MonthlyRetentionSchedule} [monthlySchedule] Monthly retention schedule of the protection policy.

retentionPolicyType

retentionPolicyType: "LongTermRetentionPolicy"
member

{string} retentionPolicyType Polymorphic Discriminator

serializedName

serializedName: string = "LongTermRetentionPolicy"

Optional weeklySchedule

weeklySchedule: WeeklyRetentionSchedule
member

{WeeklyRetentionSchedule} [weeklySchedule] Weekly retention schedule of the protection policy.

Optional yearlySchedule

yearlySchedule: YearlyRetentionSchedule
member

{YearlyRetentionSchedule} [yearlySchedule] Yearly retention schedule of the protection policy.

type

type: object

className

className: string = "LongTermRetentionPolicy"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RetentionPolicy.type.polymorphicDiscriminator

uberParent

uberParent: string = "RetentionPolicy"

modelProperties

modelProperties: object

dailySchedule

dailySchedule: object

serializedName

serializedName: string = "dailySchedule"

type

type: object

className

className: string = "DailyRetentionSchedule"

name

name: "Composite" = "Composite"

monthlySchedule

monthlySchedule: object

serializedName

serializedName: string = "monthlySchedule"

type

type: object

className

className: string = "MonthlyRetentionSchedule"

name

name: "Composite" = "Composite"

weeklySchedule

weeklySchedule: object

serializedName

serializedName: string = "weeklySchedule"

type

type: object

className

className: string = "WeeklyRetentionSchedule"

name

name: "Composite" = "Composite"

yearlySchedule

yearlySchedule: object

serializedName

serializedName: string = "yearlySchedule"

type

type: object

className

className: string = "YearlyRetentionSchedule"

name

name: "Composite" = "Composite"

Const LongTermSchedulePolicy

LongTermSchedulePolicy: object
interface

An interface representing LongTermSchedulePolicy. Long term policy schedule.

schedulePolicyType

schedulePolicyType: "LongTermSchedulePolicy"
member

{string} schedulePolicyType Polymorphic Discriminator

serializedName

serializedName: string = "LongTermSchedulePolicy"

type

type: object

className

className: string = "LongTermSchedulePolicy"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = SchedulePolicy.type.polymorphicDiscriminator

uberParent

uberParent: string = "SchedulePolicy"

modelProperties

modelProperties: object

Const MABContainerHealthDetails

MABContainerHealthDetails: object
interface

An interface representing MABContainerHealthDetails. MAB workload-specific Health Details.

Optional code

code: undefined | number
member

{number} [code] Health Code

Optional message

message: undefined | string
member

{string} [message] Health Message

Optional recommendations

recommendations: string[]
member

{string[]} [recommendations] Health Recommended Actions

serializedName

serializedName: string = "MABContainerHealthDetails"

Optional title

title: undefined | string
member

{string} [title] Health Title

type

type: object

className

className: string = "MABContainerHealthDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "Number" = "Number"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

recommendations

recommendations: object

serializedName

serializedName: string = "recommendations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

title

title: object

serializedName

serializedName: string = "title"

type

type: object

name

name: "String" = "String"

Const MabContainer

MabContainer: object
interface

An interface representing MabContainer. Container with items backed up using MAB backup engine.

Optional agentVersion

agentVersion: undefined | string
member

{string} [agentVersion] Agent version of this container.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional canReRegister

canReRegister: undefined | false | true
member

{boolean} [canReRegister] Can the container be registered one more time.

Optional containerHealthState

containerHealthState: undefined | string
member

{string} [containerHealthState] Health state of mab container.

Optional containerId

containerId: undefined | number
member

{number} [containerId] ContainerID represents the container.

containerType

containerType: "Windows"
member

{string} containerType Polymorphic Discriminator

Optional extendedInfo

extendedInfo: MabContainerExtendedInfo
member

{MabContainerExtendedInfo} [extendedInfo] Additional information for this container

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the container.

Optional healthStatus

healthStatus: undefined | string
member

{string} [healthStatus] Status of health of the container.

Optional mabContainerHealthDetails

mabContainerHealthDetails: MABContainerHealthDetails[]
member

{MABContainerHealthDetails[]} [mabContainerHealthDetails] Health details on this mab container.

Optional protectedItemCount

protectedItemCount: undefined | number
member

{number} [protectedItemCount] Number of items backed up in this container.

Optional registrationStatus

registrationStatus: undefined | string
member

{string} [registrationStatus] Status of registration of the container with the Recovery Services Vault.

serializedName

serializedName: string = "Windows"

type

type: object

className

className: string = "MabContainer"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionContainer.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionContainer"

modelProperties

modelProperties: object

agentVersion

agentVersion: object

serializedName

serializedName: string = "agentVersion"

type

type: object

name

name: "String" = "String"

canReRegister

canReRegister: object

serializedName

serializedName: string = "canReRegister"

type

type: object

name

name: "Boolean" = "Boolean"

containerHealthState

containerHealthState: object

serializedName

serializedName: string = "containerHealthState"

type

type: object

name

name: "String" = "String"

containerId

containerId: object

serializedName

serializedName: string = "containerId"

type

type: object

name

name: "Number" = "Number"

extendedInfo

extendedInfo: object

serializedName

serializedName: string = "extendedInfo"

type

type: object

className

className: string = "MabContainerExtendedInfo"

name

name: "Composite" = "Composite"

mabContainerHealthDetails

mabContainerHealthDetails: object

serializedName

serializedName: string = "mabContainerHealthDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MABContainerHealthDetails"

name

name: "Composite" = "Composite"

protectedItemCount

protectedItemCount: object

serializedName

serializedName: string = "protectedItemCount"

type

type: object

name

name: "Number" = "Number"

Const MabContainerExtendedInfo

MabContainerExtendedInfo: object
interface

An interface representing MabContainerExtendedInfo. Additional information of the container.

Optional backupItemType

backupItemType: BackupItemType
member

{BackupItemType} [backupItemType] Type of backup items associated with this container. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

Optional backupItems

backupItems: string[]
member

{string[]} [backupItems] List of backup items associated with this container.

Optional lastBackupStatus

lastBackupStatus: undefined | string
member

{string} [lastBackupStatus] Latest backup status of this container.

Optional lastRefreshedAt

lastRefreshedAt: Date
member

{Date} [lastRefreshedAt] Time stamp when this container was refreshed.

Optional policyName

policyName: undefined | string
member

{string} [policyName] Backup policy associated with this container.

serializedName

serializedName: string = "MabContainerExtendedInfo"

type

type: object

className

className: string = "MabContainerExtendedInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupItemType

backupItemType: object

serializedName

serializedName: string = "backupItemType"

type

type: object

name

name: "String" = "String"

backupItems

backupItems: object

serializedName

serializedName: string = "backupItems"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

lastBackupStatus

lastBackupStatus: object

serializedName

serializedName: string = "lastBackupStatus"

type

type: object

name

name: "String" = "String"

lastRefreshedAt

lastRefreshedAt: object

serializedName

serializedName: string = "lastRefreshedAt"

type

type: object

name

name: "DateTime" = "DateTime"

policyName

policyName: object

serializedName

serializedName: string = "policyName"

type

type: object

name

name: "String" = "String"

Const MabErrorInfo

MabErrorInfo: object
interface

An interface representing MabErrorInfo. MAB workload-specific error information.

Optional errorString

errorString: undefined | string
member

{string} [errorString] Localized error string.

Optional recommendations

recommendations: string[]
member

{string[]} [recommendations] List of localized recommendations.

serializedName

serializedName: string = "MabErrorInfo"

type

type: object

className

className: string = "MabErrorInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

errorString

errorString: object

serializedName

serializedName: string = "errorString"

type

type: object

name

name: "String" = "String"

recommendations

recommendations: object

serializedName

serializedName: string = "recommendations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const MabFileFolderProtectedItem

MabFileFolderProtectedItem: object
interface

An interface representing MabFileFolderProtectedItem. MAB workload-specific backup item.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional backupSetName

backupSetName: undefined | string
member

{string} [backupSetName] Name of the backup set the backup item belongs to

Optional computerName

computerName: undefined | string
member

{string} [computerName] Name of the computer associated with this backup item.

Optional containerName

containerName: undefined | string
member

{string} [containerName] Unique name of container

Optional createMode

createMode: CreateMode
member

{CreateMode} [createMode] Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: 'Invalid', 'Default', 'Recover'

Optional deferredDeleteSyncTimeInUTC

deferredDeleteSyncTimeInUTC: undefined | number
member

{number} [deferredDeleteSyncTimeInUTC] Sync time for deferred deletion.

Optional extendedInfo

extendedInfo: MabFileFolderProtectedItemExtendedInfo
member

{MabFileFolderProtectedItemExtendedInfo} [extendedInfo] Additional information with this backup item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of this backup item.

Optional isScheduledForDeferredDelete

isScheduledForDeferredDelete: undefined | false | true
member

{boolean} [isScheduledForDeferredDelete] Specifies if the item is scheduled for deferred deletion.

Optional lastBackupStatus

lastBackupStatus: undefined | string
member

{string} [lastBackupStatus] Status of last backup operation.

Optional lastRecoveryPoint

lastRecoveryPoint: Date
member

{Date} [lastRecoveryPoint] Timestamp when the last (latest) backup copy was created for this backup item.

Optional policyId

policyId: undefined | string
member

{string} [policyId] ID of the backup policy with which this item is backed up.

protectedItemType

protectedItemType: "MabFileFolderProtectedItem"
member

{string} protectedItemType Polymorphic Discriminator

Optional protectionState

protectionState: undefined | string
member

{string} [protectionState] Protected, ProtectionStopped, IRPending or ProtectionError

serializedName

serializedName: string = "MabFileFolderProtectedItem"

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] ARM ID of the resource to be backed up.

Optional workloadType

workloadType: DataSourceType
member

{DataSourceType} [workloadType] Type of workload this item represents. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

type

type: object

className

className: string = "MabFileFolderProtectedItem"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectedItem.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectedItem"

modelProperties

modelProperties: object

computerName

computerName: object

serializedName

serializedName: string = "computerName"

type

type: object

name

name: "String" = "String"

deferredDeleteSyncTimeInUTC

deferredDeleteSyncTimeInUTC: object

serializedName

serializedName: string = "deferredDeleteSyncTimeInUTC"

type

type: object

name

name: "Number" = "Number"

extendedInfo

extendedInfo: object

serializedName

serializedName: string = "extendedInfo"

type

type: object

className

className: string = "MabFileFolderProtectedItemExtendedInfo"

name

name: "Composite" = "Composite"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

isScheduledForDeferredDelete

isScheduledForDeferredDelete: object

serializedName

serializedName: string = "isScheduledForDeferredDelete"

type

type: object

name

name: "Boolean" = "Boolean"

lastBackupStatus

lastBackupStatus: object

serializedName

serializedName: string = "lastBackupStatus"

type

type: object

name

name: "String" = "String"

protectionState

protectionState: object

serializedName

serializedName: string = "protectionState"

type

type: object

name

name: "String" = "String"

Const MabFileFolderProtectedItemExtendedInfo

MabFileFolderProtectedItemExtendedInfo: object
interface

An interface representing MabFileFolderProtectedItemExtendedInfo. Additional information on the backed up item.

Optional lastRefreshedAt

lastRefreshedAt: Date
member

{Date} [lastRefreshedAt] Last time when the agent data synced to service.

Optional oldestRecoveryPoint

oldestRecoveryPoint: Date
member

{Date} [oldestRecoveryPoint] The oldest backup copy available.

Optional recoveryPointCount

recoveryPointCount: undefined | number
member

{number} [recoveryPointCount] Number of backup copies associated with the backup item.

serializedName

serializedName: string = "MabFileFolderProtectedItemExtendedInfo"

type

type: object

className

className: string = "MabFileFolderProtectedItemExtendedInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

lastRefreshedAt

lastRefreshedAt: object

serializedName

serializedName: string = "lastRefreshedAt"

type

type: object

name

name: "DateTime" = "DateTime"

oldestRecoveryPoint

oldestRecoveryPoint: object

serializedName

serializedName: string = "oldestRecoveryPoint"

type

type: object

name

name: "DateTime" = "DateTime"

recoveryPointCount

recoveryPointCount: object

serializedName

serializedName: string = "recoveryPointCount"

type

type: object

name

name: "Number" = "Number"

Const MabJob

MabJob: object
interface

An interface representing MabJob. MAB workload-specific job.

Optional actionsInfo

actionsInfo: JobSupportedAction[]
member

{JobSupportedAction[]} [actionsInfo] The state/actions applicable on jobs like cancel/retry.

Optional activityId

activityId: undefined | string
member

{string} [activityId] ActivityId of job.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Backup management type to execute the current job. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional duration

duration: undefined | string
member

{string} [duration] Time taken by job to run.

Optional endTime

endTime: Date
member

{Date} [endTime] The end time.

Optional entityFriendlyName

entityFriendlyName: undefined | string
member

{string} [entityFriendlyName] Friendly name of the entity on which the current job is executing.

Optional errorDetails

errorDetails: MabErrorInfo[]
member

{MabErrorInfo[]} [errorDetails] The errors.

Optional extendedInfo

extendedInfo: MabJobExtendedInfo
member

{MabJobExtendedInfo} [extendedInfo] Additional information on the job.

jobType

jobType: "MabJob"
member

{string} jobType Polymorphic Discriminator

Optional mabServerName

mabServerName: undefined | string
member

{string} [mabServerName] Name of server protecting the DS.

Optional mabServerType

mabServerType: MabServerType
member

{MabServerType} [mabServerType] Server type of MAB container. Possible values include: 'Invalid', 'Unknown', 'IaasVMContainer', 'IaasVMServiceContainer', 'DPMContainer', 'AzureBackupServerContainer', 'MABContainer', 'Cluster', 'AzureSqlContainer', 'Windows', 'VCenter', 'VMAppContainer', 'SQLAGWorkLoadContainer', 'StorageContainer', 'GenericContainer'

Optional operation

operation: undefined | string
member

{string} [operation] The operation name.

serializedName

serializedName: string = "MabJob"

Optional startTime

startTime: Date
member

{Date} [startTime] The start time.

Optional status

status: undefined | string
member

{string} [status] Job status.

Optional workloadType

workloadType: WorkloadType
member

{WorkloadType} [workloadType] Workload type of backup item. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

type

type: object

className

className: string = "MabJob"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = Job.type.polymorphicDiscriminator

uberParent

uberParent: string = "Job"

modelProperties

modelProperties: object

actionsInfo

actionsInfo: object

serializedName

serializedName: string = "actionsInfo"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["Invalid","Cancellable","Retriable"]

name

name: "Enum" = "Enum"

duration

duration: object

serializedName

serializedName: string = "duration"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

errorDetails

errorDetails: object

serializedName

serializedName: string = "errorDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MabErrorInfo"

name

name: "Composite" = "Composite"

extendedInfo

extendedInfo: object

serializedName

serializedName: string = "extendedInfo"

type

type: object

className

className: string = "MabJobExtendedInfo"

name

name: "Composite" = "Composite"

mabServerName

mabServerName: object

serializedName

serializedName: string = "mabServerName"

type

type: object

name

name: "String" = "String"

mabServerType

mabServerType: object

serializedName

serializedName: string = "mabServerType"

type

type: object

name

name: "String" = "String"

workloadType

workloadType: object

serializedName

serializedName: string = "workloadType"

type

type: object

name

name: "String" = "String"

Const MabJobExtendedInfo

MabJobExtendedInfo: object
interface

An interface representing MabJobExtendedInfo. Additional information for the MAB workload-specific job.

Optional dynamicErrorMessage

dynamicErrorMessage: undefined | string
member

{string} [dynamicErrorMessage] Non localized error message specific to this job.

Optional propertyBag

propertyBag: undefined | object
member

{{ [propertyName: string]: string }} [propertyBag] The job properties.

serializedName

serializedName: string = "MabJobExtendedInfo"

Optional tasksList

tasksList: MabJobTaskDetails[]
member

{MabJobTaskDetails[]} [tasksList] List of tasks for this job.

type

type: object

className

className: string = "MabJobExtendedInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dynamicErrorMessage

dynamicErrorMessage: object

serializedName

serializedName: string = "dynamicErrorMessage"

type

type: object

name

name: "String" = "String"

propertyBag

propertyBag: object

serializedName

serializedName: string = "propertyBag"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

tasksList

tasksList: object

serializedName

serializedName: string = "tasksList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MabJobTaskDetails"

name

name: "Composite" = "Composite"

Const MabJobTaskDetails

MabJobTaskDetails: object
interface

An interface representing MabJobTaskDetails. MAB workload-specific job task details.

Optional duration

duration: undefined | string
member

{string} [duration] Time elapsed for task.

Optional endTime

endTime: Date
member

{Date} [endTime] The end time.

serializedName

serializedName: string = "MabJobTaskDetails"

Optional startTime

startTime: Date
member

{Date} [startTime] The start time.

Optional status

status: undefined | string
member

{string} [status] The status.

Optional taskId

taskId: undefined | string
member

{string} [taskId] The task display name.

type

type: object

className

className: string = "MabJobTaskDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

duration

duration: object

serializedName

serializedName: string = "duration"

type

type: object

name

name: "TimeSpan" = "TimeSpan"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

taskId

taskId: object

serializedName

serializedName: string = "taskId"

type

type: object

name

name: "String" = "String"

Const MabProtectionPolicy

MabProtectionPolicy: object
interface

An interface representing MabProtectionPolicy. Mab container-specific backup policy.

backupManagementType

backupManagementType: "MAB"
member

{string} backupManagementType Polymorphic Discriminator

Optional protectedItemsCount

protectedItemsCount: undefined | number
member

{number} [protectedItemsCount] Number of items associated with this policy.

Optional retentionPolicy

retentionPolicy: RetentionPolicyUnion
member

{RetentionPolicyUnion} [retentionPolicy] Retention policy details.

Optional schedulePolicy

schedulePolicy: SchedulePolicyUnion
member

{SchedulePolicyUnion} [schedulePolicy] Backup schedule of backup policy.

serializedName

serializedName: string = "MAB"

type

type: object

className

className: string = "MabProtectionPolicy"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ProtectionPolicy.type.polymorphicDiscriminator

uberParent

uberParent: string = "ProtectionPolicy"

modelProperties

modelProperties: object

retentionPolicy

retentionPolicy: object

serializedName

serializedName: string = "retentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

name: "Composite" = "Composite"

schedulePolicy

schedulePolicy: object

serializedName

serializedName: string = "schedulePolicy"

type

type: object

className

className: string = "SchedulePolicy"

name

name: "Composite" = "Composite"

Const MonthlyRetentionSchedule

MonthlyRetentionSchedule: object
interface

An interface representing MonthlyRetentionSchedule. Monthly retention schedule.

Optional retentionDuration

retentionDuration: RetentionDuration
member

{RetentionDuration} [retentionDuration] Retention duration of retention Policy.

Optional retentionScheduleDaily

retentionScheduleDaily: DailyRetentionFormat
member

{DailyRetentionFormat} [retentionScheduleDaily] Daily retention format for monthly retention policy.

Optional retentionScheduleFormatType

retentionScheduleFormatType: RetentionScheduleFormat
member

{RetentionScheduleFormat} [retentionScheduleFormatType] Retention schedule format type for monthly retention policy. Possible values include: 'Invalid', 'Daily', 'Weekly'

Optional retentionScheduleWeekly

retentionScheduleWeekly: WeeklyRetentionFormat
member

{WeeklyRetentionFormat} [retentionScheduleWeekly] Weekly retention format for monthly retention policy.

Optional retentionTimes

retentionTimes: Date[] | string[]
member

{Date[] | string[]} [retentionTimes] Retention times of retention policy.

serializedName

serializedName: string = "MonthlyRetentionSchedule"

type

type: object

className

className: string = "MonthlyRetentionSchedule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

retentionDuration

retentionDuration: object

serializedName

serializedName: string = "retentionDuration"

type

type: object

className

className: string = "RetentionDuration"

name

name: "Composite" = "Composite"

retentionScheduleDaily

retentionScheduleDaily: object

serializedName

serializedName: string = "retentionScheduleDaily"

type

type: object

className

className: string = "DailyRetentionFormat"

name

name: "Composite" = "Composite"

retentionScheduleFormatType

retentionScheduleFormatType: object

serializedName

serializedName: string = "retentionScheduleFormatType"

type

type: object

name

name: "String" = "String"

retentionScheduleWeekly

retentionScheduleWeekly: object

serializedName

serializedName: string = "retentionScheduleWeekly"

type

type: object

className

className: string = "WeeklyRetentionFormat"

name

name: "Composite" = "Composite"

retentionTimes

retentionTimes: object

serializedName

serializedName: string = "retentionTimes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "DateTime" = "DateTime"

Const NameInfo

NameInfo: object
interface

An interface representing NameInfo. The name of usage.

Optional localizedValue

localizedValue: undefined | string
member

{string} [localizedValue] Localized value of usage.

serializedName

serializedName: string = "NameInfo"

Optional value

value: undefined | string
member

{string} [value] Value of usage.

type

type: object

className

className: string = "NameInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

localizedValue

localizedValue: object

serializedName

serializedName: string = "localizedValue"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const OperationResultInfo

OperationResultInfo: object
interface

An interface representing OperationResultInfo. Operation result info.

Optional jobList

jobList: string[]
member

{string[]} [jobList] List of jobs created by this operation.

objectType

objectType: "OperationResultInfo"
member

{string} objectType Polymorphic Discriminator

serializedName

serializedName: string = "OperationResultInfo"

type

type: object

className

className: string = "OperationResultInfo"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = OperationResultInfoBase.type.polymorphicDiscriminator

uberParent

uberParent: string = "OperationResultInfoBase"

modelProperties

modelProperties: object

jobList

jobList: object

serializedName

serializedName: string = "jobList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const OperationResultInfoBase

OperationResultInfoBase: object
interface

An interface representing OperationResultInfoBase. Base class for operation result info.

objectType

objectType: "OperationResultInfoBase"
member

{string} objectType Polymorphic Discriminator

serializedName

serializedName: string = "OperationResultInfoBase"

type

type: object

className

className: string = "OperationResultInfoBase"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "OperationResultInfoBase"

modelProperties

modelProperties: object

objectType

objectType: object

required

required: true = true

serializedName

serializedName: string = "objectType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "objectType"

serializedName

serializedName: string = "objectType"

Const OperationResultInfoBaseResource

OperationResultInfoBaseResource: object
interface

An interface representing OperationResultInfoBaseResource. Base class for operation result info.

extends

OperationWorkerResponse

Optional headers

headers: undefined | object
member

{{ [propertyName: string]: string[] }} [headers] HTTP headers associated with this operation.

Optional operation

operation: OperationResultInfoBaseUnion
member

{OperationResultInfoBaseUnion} [operation] OperationResultInfoBaseResource operation

serializedName

serializedName: string = "OperationResultInfoBaseResource"

Optional statusCode

statusCode: HttpStatusCode
member

{HttpStatusCode} [statusCode] HTTP Status Code of the operation. Possible values include: 'Continue', 'SwitchingProtocols', 'OK', 'Created', 'Accepted', 'NonAuthoritativeInformation', 'NoContent', 'ResetContent', 'PartialContent', 'MultipleChoices', 'Ambiguous', 'MovedPermanently', 'Moved', 'Found', 'Redirect', 'SeeOther', 'RedirectMethod', 'NotModified', 'UseProxy', 'Unused', 'TemporaryRedirect', 'RedirectKeepVerb', 'BadRequest', 'Unauthorized', 'PaymentRequired', 'Forbidden', 'NotFound', 'MethodNotAllowed', 'NotAcceptable', 'ProxyAuthenticationRequired', 'RequestTimeout', 'Conflict', 'Gone', 'LengthRequired', 'PreconditionFailed', 'RequestEntityTooLarge', 'RequestUriTooLong', 'UnsupportedMediaType', 'RequestedRangeNotSatisfiable', 'ExpectationFailed', 'UpgradeRequired', 'InternalServerError', 'NotImplemented', 'BadGateway', 'ServiceUnavailable', 'GatewayTimeout', 'HttpVersionNotSupported'

type

type: object

className

className: string = "OperationResultInfoBaseResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

operation

operation: object

serializedName

serializedName: string = "operation"

type

type: object

className

className: string = "OperationResultInfoBase"

name

name: "Composite" = "Composite"

Const OperationStatus

OperationStatus: object
interface

An interface representing OperationStatus. Operation status.

Optional endTime

endTime: Date
member

{Date} [endTime] Operation end time. Format: ISO-8601.

Optional error

error: OperationStatusError
member

{OperationStatusError} [error] Error information related to this operation.

Optional id

id: undefined | string
member

{string} [id] ID of the operation.

Optional name

name: undefined | string
member

{string} [name] Name of the operation.

Optional properties

properties: OperationStatusExtendedInfoUnion
member

{OperationStatusExtendedInfoUnion} [properties] Additional information associated with this operation.

serializedName

serializedName: string = "OperationStatus"

Optional startTime

startTime: Date
member

{Date} [startTime] Operation start time. Format: ISO-8601.

Optional status

status: OperationStatusValues
member

{OperationStatusValues} [status] Operation status. Possible values include: 'Invalid', 'InProgress', 'Succeeded', 'Failed', 'Canceled'

type

type: object

className

className: string = "OperationStatus"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "OperationStatusError"

name

name: "Composite" = "Composite"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "OperationStatusExtendedInfo"

name

name: "Composite" = "Composite"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const OperationStatusError

OperationStatusError: object
interface

An interface representing OperationStatusError. Error information associated with operation status call.

Optional code

code: undefined | string
member

{string} [code] Error code of the operation failure.

Optional message

message: undefined | string
member

{string} [message] Error message displayed if the operation failure.

serializedName

serializedName: string = "OperationStatusError"

type

type: object

className

className: string = "OperationStatusError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

Const OperationStatusExtendedInfo

OperationStatusExtendedInfo: object
interface

An interface representing OperationStatusExtendedInfo. Base class for additional information of operation status.

objectType

objectType: "OperationStatusExtendedInfo"
member

{string} objectType Polymorphic Discriminator

serializedName

serializedName: string = "OperationStatusExtendedInfo"

type

type: object

className

className: string = "OperationStatusExtendedInfo"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "OperationStatusExtendedInfo"

modelProperties

modelProperties: object

objectType

objectType: object

required

required: true = true

serializedName

serializedName: string = "objectType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "objectType"

serializedName

serializedName: string = "objectType"

Const OperationStatusJobExtendedInfo

OperationStatusJobExtendedInfo: object
interface

An interface representing OperationStatusJobExtendedInfo. Operation status job extended info.

Optional jobId

jobId: undefined | string
member

{string} [jobId] ID of the job created for this protected item.

objectType

objectType: "OperationStatusJobExtendedInfo"
member

{string} objectType Polymorphic Discriminator

serializedName

serializedName: string = "OperationStatusJobExtendedInfo"

type

type: object

className

className: string = "OperationStatusJobExtendedInfo"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = OperationStatusExtendedInfo.type.polymorphicDiscriminator

uberParent

uberParent: string = "OperationStatusExtendedInfo"

modelProperties

modelProperties: object

jobId

jobId: object

serializedName

serializedName: string = "jobId"

type

type: object

name

name: "String" = "String"

Const OperationStatusJobsExtendedInfo

OperationStatusJobsExtendedInfo: object
interface

An interface representing OperationStatusJobsExtendedInfo. Operation status extended info for list of jobs.

Optional failedJobsError

failedJobsError: undefined | object
member

{{ [propertyName: string]: string }} [failedJobsError] Stores all the failed jobs along with the corresponding error codes.

Optional jobIds

jobIds: string[]
member

{string[]} [jobIds] IDs of the jobs created for the protected item.

objectType

objectType: "OperationStatusJobsExtendedInfo"
member

{string} objectType Polymorphic Discriminator

serializedName

serializedName: string = "OperationStatusJobsExtendedInfo"

type

type: object

className

className: string = "OperationStatusJobsExtendedInfo"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = OperationStatusExtendedInfo.type.polymorphicDiscriminator

uberParent

uberParent: string = "OperationStatusExtendedInfo"

modelProperties

modelProperties: object

failedJobsError

failedJobsError: object

serializedName

serializedName: string = "failedJobsError"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

jobIds

jobIds: object

serializedName

serializedName: string = "jobIds"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const OperationStatusProvisionILRExtendedInfo

OperationStatusProvisionILRExtendedInfo: object
interface

An interface representing OperationStatusProvisionILRExtendedInfo. Operation status extended info for ILR provision action.

objectType

objectType: "OperationStatusProvisionILRExtendedInfo"
member

{string} objectType Polymorphic Discriminator

Optional recoveryTarget

recoveryTarget: InstantItemRecoveryTarget
member

{InstantItemRecoveryTarget} [recoveryTarget] Target details for file / folder restore.

serializedName

serializedName: string = "OperationStatusProvisionILRExtendedInfo"

type

type: object

className

className: string = "OperationStatusProvisionILRExtendedInfo"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = OperationStatusExtendedInfo.type.polymorphicDiscriminator

uberParent

uberParent: string = "OperationStatusExtendedInfo"

modelProperties

modelProperties: object

recoveryTarget

recoveryTarget: object

serializedName

serializedName: string = "recoveryTarget"

type

type: object

className

className: string = "InstantItemRecoveryTarget"

name

name: "Composite" = "Composite"

Const OperationWorkerResponse

OperationWorkerResponse: object
interface

An interface representing OperationWorkerResponse. This is the base class for operation result responses.

Optional headers

headers: undefined | object
member

{{ [propertyName: string]: string[] }} [headers] HTTP headers associated with this operation.

serializedName

serializedName: string = "OperationWorkerResponse"

Optional statusCode

statusCode: HttpStatusCode
member

{HttpStatusCode} [statusCode] HTTP Status Code of the operation. Possible values include: 'Continue', 'SwitchingProtocols', 'OK', 'Created', 'Accepted', 'NonAuthoritativeInformation', 'NoContent', 'ResetContent', 'PartialContent', 'MultipleChoices', 'Ambiguous', 'MovedPermanently', 'Moved', 'Found', 'Redirect', 'SeeOther', 'RedirectMethod', 'NotModified', 'UseProxy', 'Unused', 'TemporaryRedirect', 'RedirectKeepVerb', 'BadRequest', 'Unauthorized', 'PaymentRequired', 'Forbidden', 'NotFound', 'MethodNotAllowed', 'NotAcceptable', 'ProxyAuthenticationRequired', 'RequestTimeout', 'Conflict', 'Gone', 'LengthRequired', 'PreconditionFailed', 'RequestEntityTooLarge', 'RequestUriTooLong', 'UnsupportedMediaType', 'RequestedRangeNotSatisfiable', 'ExpectationFailed', 'UpgradeRequired', 'InternalServerError', 'NotImplemented', 'BadGateway', 'ServiceUnavailable', 'GatewayTimeout', 'HttpVersionNotSupported'

type

type: object

className

className: string = "OperationWorkerResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

headers

headers: object

serializedName

serializedName: string = "headers"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

statusCode

statusCode: object

serializedName

serializedName: string = "statusCode"

type

type: object

allowedValues

allowedValues: string[] = ["Continue","SwitchingProtocols","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultipleChoices","Ambiguous","MovedPermanently","Moved","Found","Redirect","SeeOther","RedirectMethod","NotModified","UseProxy","Unused","TemporaryRedirect","RedirectKeepVerb","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","UpgradeRequired","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported"]

name

name: "Enum" = "Enum"

Const PointInTimeRange

PointInTimeRange: object
interface

An interface representing PointInTimeRange. Provides details for log ranges

Optional endTime

endTime: Date
member

{Date} [endTime] End time of the time range for log recovery.

serializedName

serializedName: string = "PointInTimeRange"

Optional startTime

startTime: Date
member

{Date} [startTime] Start time of the time range for log recovery.

type

type: object

className

className: string = "PointInTimeRange"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const PreBackupValidation

PreBackupValidation: object
interface

An interface representing PreBackupValidation. Pre-backup validation for Azure VM Workload provider.

Optional code

code: undefined | string
member

{string} [code] Error code of protectable item

Optional message

message: undefined | string
member

{string} [message] Message corresponding to the error code for the protectable item

serializedName

serializedName: string = "PreBackupValidation"

Optional status

status: InquiryStatus
member

{InquiryStatus} [status] Status of protectable item, i.e. InProgress,Succeeded,Failed. Possible values include: 'Invalid', 'Success', 'Failed'

type

type: object

className

className: string = "PreBackupValidation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const PreValidateEnableBackupRequest

PreValidateEnableBackupRequest: object
interface

An interface representing PreValidateEnableBackupRequest. Contract to validate if backup can be enabled on the given resource in a given vault and given configuration. It will validate followings

  1. Vault capacity
  2. VM is already protected
  3. Any VM related configuration passed in properties.

Optional properties

properties: undefined | string
member

{string} [properties] Configuration of VM if any needs to be validated like OS type etc

Optional resourceId

resourceId: undefined | string
member

{string} [resourceId] ARM Virtual Machine Id

Optional resourceType

resourceType: DataSourceType
member

{DataSourceType} [resourceType] ProtectedItem Type- VM, SqlDataBase, AzureFileShare etc. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

serializedName

serializedName: string = "PreValidateEnableBackupRequest"

type

type: object

className

className: string = "PreValidateEnableBackupRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

name

name: "String" = "String"

resourceId

resourceId: object

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

resourceType

resourceType: object

serializedName

serializedName: string = "resourceType"

type

type: object

name

name: "String" = "String"

Const PreValidateEnableBackupResponse

PreValidateEnableBackupResponse: object
interface

An interface representing PreValidateEnableBackupResponse. Response contract for enable backup validation request

Optional containerName

containerName: undefined | string
member

{string} [containerName] Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;rgname;vmname. This is required for portal

Optional errorCode

errorCode: undefined | string
member

{string} [errorCode] Response error code

Optional errorMessage

errorMessage: undefined | string
member

{string} [errorMessage] Response error message

Optional protectedItemName

protectedItemName: undefined | string
member

{string} [protectedItemName] Specifies the product specific ds name. E.g. vm;iaasvmcontainer;rgname;vmname. This is required for portal

Optional recommendation

recommendation: undefined | string
member

{string} [recommendation] Recommended action for user

serializedName

serializedName: string = "PreValidateEnableBackupResponse"

Optional status

status: ValidationStatus
member

{ValidationStatus} [status] Validation Status. Possible values include: 'Invalid', 'Succeeded', 'Failed'

type

type: object

className

className: string = "PreValidateEnableBackupResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containerName

containerName: object

serializedName

serializedName: string = "containerName"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "errorCode"

type

type: object

name

name: "String" = "String"

errorMessage

errorMessage: object

serializedName

serializedName: string = "errorMessage"

type

type: object

name

name: "String" = "String"

protectedItemName

protectedItemName: object

serializedName

serializedName: string = "protectedItemName"

type

type: object

name

name: "String" = "String"

recommendation

recommendation: object

serializedName

serializedName: string = "recommendation"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const ProtectableContainer

ProtectableContainer: object
interface

An interface representing ProtectableContainer. Protectable Container Class.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional containerId

containerId: undefined | string
member

{string} [containerId] Fabric Id of the container such as ARM Id.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the container.

Optional healthStatus

healthStatus: undefined | string
member

{string} [healthStatus] Status of health of the container.

protectableContainerType

protectableContainerType: "ProtectableContainer"
member

{string} protectableContainerType Polymorphic Discriminator

serializedName

serializedName: string = "ProtectableContainer"

type

type: object

className

className: string = "ProtectableContainer"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ProtectableContainer"

modelProperties

modelProperties: object

backupManagementType

backupManagementType: object

serializedName

serializedName: string = "backupManagementType"

type

type: object

name

name: "String" = "String"

containerId

containerId: object

serializedName

serializedName: string = "containerId"

type

type: object

name

name: "String" = "String"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

healthStatus

healthStatus: object

serializedName

serializedName: string = "healthStatus"

type

type: object

name

name: "String" = "String"

protectableContainerType

protectableContainerType: object

required

required: true = true

serializedName

serializedName: string = "protectableContainerType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "protectableContainerType"

serializedName

serializedName: string = "protectableContainerType"

Const ProtectableContainerResource

ProtectableContainerResource: object
interface

An interface representing ProtectableContainerResource. Protectable Container Class.

extends

Resource

Optional eTag

eTag: undefined | string
member

{string} [eTag] Optional ETag.

Optional id

id: undefined | string
member

{string} [id] Resource Id represents the complete path to the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource location.

Optional name

name: undefined | string
member

{string} [name] Resource name associated with the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: ProtectableContainerUnion
member

{ProtectableContainerUnion} [properties] ProtectableContainerResource properties

serializedName

serializedName: string = "ProtectableContainerResource"

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

type

type: object

className

className: string = "ProtectableContainerResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "ProtectableContainer"

name

name: "Composite" = "Composite"

Const ProtectableContainerResourceList

ProtectableContainerResourceList: object
interface

An interface representing the ProtectableContainerResourceList. List of ProtectableContainer resources

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "ProtectableContainerResourceList"

__@iterator

  • __@iterator(): IterableIterator<ProtectableContainerResource>

  • Iterator

    Returns IterableIterator<ProtectableContainerResource>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ProtectableContainerResource>[]): ProtectableContainerResource[]
  • concat(...items: (T | ConcatArray<T>)[]): ProtectableContainerResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ProtectableContainerResource>[]

      Additional items to add to the end of array1.

    Returns ProtectableContainerResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ProtectableContainerResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ProtectableContainerResource]>

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ProtectableContainerResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ProtectableContainerResource, index: number, array: ProtectableContainerResource[]): boolean

        • Parameters

          • value: ProtectableContainerResource
          • index: number
          • array: ProtectableContainerResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ProtectableContainerResource, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ProtectableContainerResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ProtectableContainerResource[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ProtectableContainerResource

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ProtectableContainerResource, index: number, array: ProtectableContainerResource[]): boolean

        • Parameters

          • value: ProtectableContainerResource
          • index: number
          • array: ProtectableContainerResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ProtectableContainerResource, index: number, array: ProtectableContainerResource[]): any

        • Parameters

          • value: ProtectableContainerResource
          • index: number
          • array: ProtectableContainerResource[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ProtectableContainerResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ProtectableContainerResource | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ProtectableContainerResource

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ProtectableContainerResource, index: number, obj: ProtectableContainerResource[]): boolean

        • Parameters

          • this: void
          • value: ProtectableContainerResource
          • index: number
          • obj: ProtectableContainerResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ProtectableContainerResource, index: number, obj: ProtectableContainerResource[]): boolean

        • Parameters

          • value: ProtectableContainerResource
          • index: number
          • obj: ProtectableContainerResource[]

          Returns boolean

    • Optional thisArg: any

    Returns ProtectableContainerResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ProtectableContainerResource, index: number, obj: ProtectableContainerResource[]): boolean

        • Parameters

          • value: ProtectableContainerResource
          • index: number
          • obj: ProtectableContainerResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ProtectableContainerResource, index: number, array: ProtectableContainerResource[]): void

        • Parameters

          • value: ProtectableContainerResource
          • index: number
          • array: ProtectableContainerResource[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ProtectableContainerResource, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ProtectableContainerResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ProtectableContainerResource, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ProtectableContainerResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ProtectableContainerResource, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ProtectableContainerResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ProtectableContainerResource, index: number, array: ProtectableContainerResource[]): U

        • Parameters

          • value: ProtectableContainerResource
          • index: number
          • array: ProtectableContainerResource[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ProtectableContainerResource | undefined

  • Removes the last element from an array and returns it.

    Returns ProtectableContainerResource | undefined

push

  • push(...items: ProtectableContainerResource[]): number

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ProtectableContainerResource[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ProtectableContainerResource
  • reduce(callbackfn: function, initialValue: ProtectableContainerResource): ProtectableContainerResource
  • reduce<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ProtectableContainerResource, currentValue: ProtectableContainerResource, currentIndex: number, array: ProtectableContainerResource[]): ProtectableContainerResource

        • Parameters

          • previousValue: ProtectableContainerResource
          • currentValue: ProtectableContainerResource
          • currentIndex: number
          • array: ProtectableContainerResource[]

          Returns ProtectableContainerResource

    Returns ProtectableContainerResource

  • Parameters

    • callbackfn: function
        • (previousValue: ProtectableContainerResource, currentValue: ProtectableContainerResource, currentIndex: number, array: ProtectableContainerResource[]): ProtectableContainerResource

        • Parameters

          • previousValue: ProtectableContainerResource
          • currentValue: ProtectableContainerResource
          • currentIndex: number
          • array: ProtectableContainerResource[]

          Returns ProtectableContainerResource

    • initialValue: ProtectableContainerResource

    Returns ProtectableContainerResource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ProtectableContainerResource, currentIndex: number, array: ProtectableContainerResource[]): U

        • Parameters

          • previousValue: U
          • currentValue: ProtectableContainerResource
          • currentIndex: number
          • array: ProtectableContainerResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ProtectableContainerResource
  • reduceRight(callbackfn: function, initialValue: ProtectableContainerResource): ProtectableContainerResource
  • reduceRight<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ProtectableContainerResource, currentValue: ProtectableContainerResource, currentIndex: number, array: ProtectableContainerResource[]): ProtectableContainerResource

        • Parameters

          • previousValue: ProtectableContainerResource
          • currentValue: ProtectableContainerResource
          • currentIndex: number
          • array: ProtectableContainerResource[]

          Returns ProtectableContainerResource

    Returns ProtectableContainerResource

  • Parameters

    • callbackfn: function
        • (previousValue: ProtectableContainerResource, currentValue: ProtectableContainerResource, currentIndex: number, array: ProtectableContainerResource[]): ProtectableContainerResource

        • Parameters

          • previousValue: ProtectableContainerResource
          • currentValue: ProtectableContainerResource
          • currentIndex: number
          • array: ProtectableContainerResource[]

          Returns ProtectableContainerResource

    • initialValue: ProtectableContainerResource

    Returns ProtectableContainerResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ProtectableContainerResource, currentIndex: number, array: ProtectableContainerResource[]): U

        • Parameters

          • previousValue: U
          • currentValue: ProtectableContainerResource
          • currentIndex: number
          • array: ProtectableContainerResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ProtectableContainerResource[]

  • Reverses the elements in an Array.

    Returns ProtectableContainerResource[]

shift

  • shift(): ProtectableContainerResource | undefined

  • Removes the first element from an array and returns it.

    Returns ProtectableContainerResource | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ProtectableContainerResource[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ProtectableContainerResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ProtectableContainerResource, index: number, array: ProtectableContainerResource[]): boolean

        • Parameters

          • value: ProtectableContainerResource
          • index: number
          • array: ProtectableContainerResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ProtectableContainerResource[]
  • splice(start: number, deleteCount: number, ...items: ProtectableContainerResource[]): ProtectableContainerResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ProtectableContainerResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ProtectableContainerResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns ProtectableContainerResource[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ProtectableContainerResource[]): number

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ProtectableContainerResource[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ProtectableContainerResource>

  • Returns an iterable of values in the array

    Returns IterableIterator<ProtectableContainerResource>

type

type: object

className

className: string = "ProtectableContainerResourceList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ProtectableContainerResource"

name

name: "Composite" = "Composite"

Const ProtectedItem

ProtectedItem: object
interface

An interface representing ProtectedItem. Base class for backup items.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional backupSetName

backupSetName: undefined | string
member

{string} [backupSetName] Name of the backup set the backup item belongs to

Optional containerName

containerName: undefined | string
member

{string} [containerName] Unique name of container

Optional createMode

createMode: CreateMode
member

{CreateMode} [createMode] Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Possible values include: 'Invalid', 'Default', 'Recover'

Optional lastRecoveryPoint

lastRecoveryPoint: Date
member

{Date} [lastRecoveryPoint] Timestamp when the last (latest) backup copy was created for this backup item.

Optional policyId

policyId: undefined | string
member

{string} [policyId] ID of the backup policy with which this item is backed up.

protectedItemType

protectedItemType: "ProtectedItem"
member

{string} protectedItemType Polymorphic Discriminator

serializedName

serializedName: string = "ProtectedItem"

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] ARM ID of the resource to be backed up.

Optional workloadType

workloadType: DataSourceType
member

{DataSourceType} [workloadType] Type of workload this item represents. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

type

type: object

className

className: string = "ProtectedItem"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ProtectedItem"

modelProperties

modelProperties: object

backupManagementType

backupManagementType: object

serializedName

serializedName: string = "backupManagementType"

type

type: object

name

name: "String" = "String"

backupSetName

backupSetName: object

serializedName

serializedName: string = "backupSetName"

type

type: object

name

name: "String" = "String"

containerName

containerName: object

serializedName

serializedName: string = "containerName"

type

type: object

name

name: "String" = "String"

createMode

createMode: object

serializedName

serializedName: string = "createMode"

type

type: object

name

name: "String" = "String"

lastRecoveryPoint

lastRecoveryPoint: object

serializedName

serializedName: string = "lastRecoveryPoint"

type

type: object

name

name: "DateTime" = "DateTime"

policyId

policyId: object

serializedName

serializedName: string = "policyId"

type

type: object

name

name: "String" = "String"

protectedItemType

protectedItemType: object

required

required: true = true

serializedName

serializedName: string = "protectedItemType"

type

type: object

name

name: "String" = "String"

sourceResourceId

sourceResourceId: object

serializedName

serializedName: string = "sourceResourceId"

type

type: object

name

name: "String" = "String"

workloadType

workloadType: object

serializedName

serializedName: string = "workloadType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "protectedItemType"

serializedName

serializedName: string = "protectedItemType"

Const ProtectedItemQueryObject

ProtectedItemQueryObject: object
interface

An interface representing ProtectedItemQueryObject. Filters to list backup items.

Optional backupEngineName

backupEngineName: undefined | string
member

{string} [backupEngineName] Backup Engine name

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Backup management type for the backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional backupSetName

backupSetName: undefined | string
member

{string} [backupSetName] Name of the backup set.

Optional containerName

containerName: undefined | string
member

{string} [containerName] Name of the container.

Optional fabricName

fabricName: undefined | string
member

{string} [fabricName] Name of the fabric.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of protected item

Optional healthState

healthState: HealthState
member

{HealthState} [healthState] Health State for the backed up item. Possible values include: 'Passed', 'ActionRequired', 'ActionSuggested', 'Invalid'

Optional itemType

itemType: DataSourceType
member

{DataSourceType} [itemType] Type of workload this item represents. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

Optional policyName

policyName: undefined | string
member

{string} [policyName] Backup policy name associated with the backup item.

serializedName

serializedName: string = "ProtectedItemQueryObject"

type

type: object

className

className: string = "ProtectedItemQueryObject"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupEngineName

backupEngineName: object

serializedName

serializedName: string = "backupEngineName"

type

type: object

name

name: "String" = "String"

backupManagementType

backupManagementType: object

serializedName

serializedName: string = "backupManagementType"

type

type: object

name

name: "String" = "String"

backupSetName

backupSetName: object

serializedName

serializedName: string = "backupSetName"

type

type: object

name

name: "String" = "String"

containerName

containerName: object

serializedName

serializedName: string = "containerName"

type

type: object

name

name: "String" = "String"

fabricName

fabricName: object

serializedName

serializedName: string = "fabricName"

type

type: object

name

name: "String" = "String"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

healthState

healthState: object

serializedName

serializedName: string = "healthState"

type

type: object

name

name: "String" = "String"

itemType

itemType: object

serializedName

serializedName: string = "itemType"

type

type: object

name

name: "String" = "String"

policyName

policyName: object

serializedName

serializedName: string = "policyName"

type

type: object

name

name: "String" = "String"

Const ProtectedItemResource

ProtectedItemResource: object
interface

An interface representing ProtectedItemResource. Base class for backup items.

extends

Resource

Optional eTag

eTag: undefined | string
member

{string} [eTag] Optional ETag.

Optional id

id: undefined | string
member

{string} [id] Resource Id represents the complete path to the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource location.

Optional name

name: undefined | string
member

{string} [name] Resource name associated with the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: ProtectedItemUnion
member

{ProtectedItemUnion} [properties] ProtectedItemResource properties

serializedName

serializedName: string = "ProtectedItemResource"

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

type

type: object

className

className: string = "ProtectedItemResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "ProtectedItem"

name

name: "Composite" = "Composite"

Const ProtectedItemResourceList

ProtectedItemResourceList: object
interface

An interface representing the ProtectedItemResourceList. List of ProtectedItem resources

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "ProtectedItemResourceList"

__@iterator

  • __@iterator(): IterableIterator<ProtectedItemResource>

  • Iterator

    Returns IterableIterator<ProtectedItemResource>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ProtectedItemResource>[]): ProtectedItemResource[]
  • concat(...items: (T | ConcatArray<T>)[]): ProtectedItemResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ProtectedItemResource>[]

      Additional items to add to the end of array1.

    Returns ProtectedItemResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ProtectedItemResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ProtectedItemResource]>

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ProtectedItemResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ProtectedItemResource, index: number, array: ProtectedItemResource[]): boolean

        • Parameters

          • value: ProtectedItemResource
          • index: number
          • array: ProtectedItemResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ProtectedItemResource, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ProtectedItemResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ProtectedItemResource[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ProtectedItemResource

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ProtectedItemResource, index: number, array: ProtectedItemResource[]): boolean

        • Parameters

          • value: ProtectedItemResource
          • index: number
          • array: ProtectedItemResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ProtectedItemResource, index: number, array: ProtectedItemResource[]): any

        • Parameters

          • value: ProtectedItemResource
          • index: number
          • array: ProtectedItemResource[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ProtectedItemResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ProtectedItemResource | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ProtectedItemResource

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ProtectedItemResource, index: number, obj: ProtectedItemResource[]): boolean

        • Parameters

          • this: void
          • value: ProtectedItemResource
          • index: number
          • obj: ProtectedItemResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ProtectedItemResource, index: number, obj: ProtectedItemResource[]): boolean

        • Parameters

          • value: ProtectedItemResource
          • index: number
          • obj: ProtectedItemResource[]

          Returns boolean

    • Optional thisArg: any

    Returns ProtectedItemResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ProtectedItemResource, index: number, obj: ProtectedItemResource[]): boolean

        • Parameters

          • value: ProtectedItemResource
          • index: number
          • obj: ProtectedItemResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ProtectedItemResource, index: number, array: ProtectedItemResource[]): void

        • Parameters

          • value: ProtectedItemResource
          • index: number
          • array: ProtectedItemResource[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ProtectedItemResource, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ProtectedItemResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ProtectedItemResource, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ProtectedItemResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ProtectedItemResource, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ProtectedItemResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ProtectedItemResource, index: number, array: ProtectedItemResource[]): U

        • Parameters

          • value: ProtectedItemResource
          • index: number
          • array: ProtectedItemResource[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ProtectedItemResource | undefined

  • Removes the last element from an array and returns it.

    Returns ProtectedItemResource | undefined

push

  • push(...items: ProtectedItemResource[]): number

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ProtectedItemResource[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ProtectedItemResource
  • reduce(callbackfn: function, initialValue: ProtectedItemResource): ProtectedItemResource
  • reduce<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ProtectedItemResource, currentValue: ProtectedItemResource, currentIndex: number, array: ProtectedItemResource[]): ProtectedItemResource

        • Parameters

          • previousValue: ProtectedItemResource
          • currentValue: ProtectedItemResource
          • currentIndex: number
          • array: ProtectedItemResource[]

          Returns ProtectedItemResource

    Returns ProtectedItemResource

  • Parameters

    • callbackfn: function
        • (previousValue: ProtectedItemResource, currentValue: ProtectedItemResource, currentIndex: number, array: ProtectedItemResource[]): ProtectedItemResource

        • Parameters

          • previousValue: ProtectedItemResource
          • currentValue: ProtectedItemResource
          • currentIndex: number
          • array: ProtectedItemResource[]

          Returns ProtectedItemResource

    • initialValue: ProtectedItemResource

    Returns ProtectedItemResource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ProtectedItemResource, currentIndex: number, array: ProtectedItemResource[]): U

        • Parameters

          • previousValue: U
          • currentValue: ProtectedItemResource
          • currentIndex: number
          • array: ProtectedItemResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ProtectedItemResource
  • reduceRight(callbackfn: function, initialValue: ProtectedItemResource): ProtectedItemResource
  • reduceRight<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ProtectedItemResource, currentValue: ProtectedItemResource, currentIndex: number, array: ProtectedItemResource[]): ProtectedItemResource

        • Parameters

          • previousValue: ProtectedItemResource
          • currentValue: ProtectedItemResource
          • currentIndex: number
          • array: ProtectedItemResource[]

          Returns ProtectedItemResource

    Returns ProtectedItemResource

  • Parameters

    • callbackfn: function
        • (previousValue: ProtectedItemResource, currentValue: ProtectedItemResource, currentIndex: number, array: ProtectedItemResource[]): ProtectedItemResource

        • Parameters

          • previousValue: ProtectedItemResource
          • currentValue: ProtectedItemResource
          • currentIndex: number
          • array: ProtectedItemResource[]

          Returns ProtectedItemResource

    • initialValue: ProtectedItemResource

    Returns ProtectedItemResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ProtectedItemResource, currentIndex: number, array: ProtectedItemResource[]): U

        • Parameters

          • previousValue: U
          • currentValue: ProtectedItemResource
          • currentIndex: number
          • array: ProtectedItemResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ProtectedItemResource[]

  • Reverses the elements in an Array.

    Returns ProtectedItemResource[]

shift

  • shift(): ProtectedItemResource | undefined

  • Removes the first element from an array and returns it.

    Returns ProtectedItemResource | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ProtectedItemResource[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ProtectedItemResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ProtectedItemResource, index: number, array: ProtectedItemResource[]): boolean

        • Parameters

          • value: ProtectedItemResource
          • index: number
          • array: ProtectedItemResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ProtectedItemResource[]
  • splice(start: number, deleteCount: number, ...items: ProtectedItemResource[]): ProtectedItemResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ProtectedItemResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ProtectedItemResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns ProtectedItemResource[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ProtectedItemResource[]): number

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ProtectedItemResource[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ProtectedItemResource>

  • Returns an iterable of values in the array

    Returns IterableIterator<ProtectedItemResource>

type

type: object

className

className: string = "ProtectedItemResourceList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ProtectedItemResource"

name

name: "Composite" = "Composite"

Const ProtectionContainer

ProtectionContainer: object
interface

An interface representing ProtectionContainer. Base class for container with backup items. Containers with specific workloads are derived from this class.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the container. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

containerType

containerType: "ProtectionContainer"
member

{string} containerType Polymorphic Discriminator

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the container.

Optional healthStatus

healthStatus: undefined | string
member

{string} [healthStatus] Status of health of the container.

Optional registrationStatus

registrationStatus: undefined | string
member

{string} [registrationStatus] Status of registration of the container with the Recovery Services Vault.

serializedName

serializedName: string = "ProtectionContainer"

type

type: object

className

className: string = "ProtectionContainer"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ProtectionContainer"

modelProperties

modelProperties: object

backupManagementType

backupManagementType: object

serializedName

serializedName: string = "backupManagementType"

type

type: object

name

name: "String" = "String"

containerType

containerType: object

required

required: true = true

serializedName

serializedName: string = "containerType"

type

type: object

name

name: "String" = "String"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

healthStatus

healthStatus: object

serializedName

serializedName: string = "healthStatus"

type

type: object

name

name: "String" = "String"

registrationStatus

registrationStatus: object

serializedName

serializedName: string = "registrationStatus"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "containerType"

serializedName

serializedName: string = "containerType"

Const ProtectionContainerResource

ProtectionContainerResource: object
interface

An interface representing ProtectionContainerResource. Base class for container with backup items. Containers with specific workloads are derived from this class.

extends

Resource

Optional eTag

eTag: undefined | string
member

{string} [eTag] Optional ETag.

Optional id

id: undefined | string
member

{string} [id] Resource Id represents the complete path to the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource location.

Optional name

name: undefined | string
member

{string} [name] Resource name associated with the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: ProtectionContainerUnion
member

{ProtectionContainerUnion} [properties] ProtectionContainerResource properties

serializedName

serializedName: string = "ProtectionContainerResource"

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

type

type: object

className

className: string = "ProtectionContainerResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "ProtectionContainer"

name

name: "Composite" = "Composite"

Const ProtectionContainerResourceList

ProtectionContainerResourceList: object
interface

An interface representing the ProtectionContainerResourceList. List of ProtectionContainer resources

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "ProtectionContainerResourceList"

__@iterator

  • __@iterator(): IterableIterator<ProtectionContainerResource>

  • Iterator

    Returns IterableIterator<ProtectionContainerResource>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ProtectionContainerResource>[]): ProtectionContainerResource[]
  • concat(...items: (T | ConcatArray<T>)[]): ProtectionContainerResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ProtectionContainerResource>[]

      Additional items to add to the end of array1.

    Returns ProtectionContainerResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ProtectionContainerResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ProtectionContainerResource]>

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ProtectionContainerResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ProtectionContainerResource, index: number, array: ProtectionContainerResource[]): boolean

        • Parameters

          • value: ProtectionContainerResource
          • index: number
          • array: ProtectionContainerResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ProtectionContainerResource, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ProtectionContainerResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ProtectionContainerResource[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ProtectionContainerResource

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ProtectionContainerResource, index: number, array: ProtectionContainerResource[]): boolean

        • Parameters

          • value: ProtectionContainerResource
          • index: number
          • array: ProtectionContainerResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ProtectionContainerResource, index: number, array: ProtectionContainerResource[]): any

        • Parameters

          • value: ProtectionContainerResource
          • index: number
          • array: ProtectionContainerResource[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ProtectionContainerResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ProtectionContainerResource | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ProtectionContainerResource

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ProtectionContainerResource, index: number, obj: ProtectionContainerResource[]): boolean

        • Parameters

          • this: void
          • value: ProtectionContainerResource
          • index: number
          • obj: ProtectionContainerResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ProtectionContainerResource, index: number, obj: ProtectionContainerResource[]): boolean

        • Parameters

          • value: ProtectionContainerResource
          • index: number
          • obj: ProtectionContainerResource[]

          Returns boolean

    • Optional thisArg: any

    Returns ProtectionContainerResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ProtectionContainerResource, index: number, obj: ProtectionContainerResource[]): boolean

        • Parameters

          • value: ProtectionContainerResource
          • index: number
          • obj: ProtectionContainerResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ProtectionContainerResource, index: number, array: ProtectionContainerResource[]): void

        • Parameters

          • value: ProtectionContainerResource
          • index: number
          • array: ProtectionContainerResource[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ProtectionContainerResource, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ProtectionContainerResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ProtectionContainerResource, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ProtectionContainerResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ProtectionContainerResource, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ProtectionContainerResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ProtectionContainerResource, index: number, array: ProtectionContainerResource[]): U

        • Parameters

          • value: ProtectionContainerResource
          • index: number
          • array: ProtectionContainerResource[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ProtectionContainerResource | undefined

  • Removes the last element from an array and returns it.

    Returns ProtectionContainerResource | undefined

push

  • push(...items: ProtectionContainerResource[]): number

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ProtectionContainerResource[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ProtectionContainerResource
  • reduce(callbackfn: function, initialValue: ProtectionContainerResource): ProtectionContainerResource
  • reduce<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ProtectionContainerResource, currentValue: ProtectionContainerResource, currentIndex: number, array: ProtectionContainerResource[]): ProtectionContainerResource

        • Parameters

          • previousValue: ProtectionContainerResource
          • currentValue: ProtectionContainerResource
          • currentIndex: number
          • array: ProtectionContainerResource[]

          Returns ProtectionContainerResource

    Returns ProtectionContainerResource

  • Parameters

    • callbackfn: function
        • (previousValue: ProtectionContainerResource, currentValue: ProtectionContainerResource, currentIndex: number, array: ProtectionContainerResource[]): ProtectionContainerResource

        • Parameters

          • previousValue: ProtectionContainerResource
          • currentValue: ProtectionContainerResource
          • currentIndex: number
          • array: ProtectionContainerResource[]

          Returns ProtectionContainerResource

    • initialValue: ProtectionContainerResource

    Returns ProtectionContainerResource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ProtectionContainerResource, currentIndex: number, array: ProtectionContainerResource[]): U

        • Parameters

          • previousValue: U
          • currentValue: ProtectionContainerResource
          • currentIndex: number
          • array: ProtectionContainerResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ProtectionContainerResource
  • reduceRight(callbackfn: function, initialValue: ProtectionContainerResource): ProtectionContainerResource
  • reduceRight<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ProtectionContainerResource, currentValue: ProtectionContainerResource, currentIndex: number, array: ProtectionContainerResource[]): ProtectionContainerResource

        • Parameters

          • previousValue: ProtectionContainerResource
          • currentValue: ProtectionContainerResource
          • currentIndex: number
          • array: ProtectionContainerResource[]

          Returns ProtectionContainerResource

    Returns ProtectionContainerResource

  • Parameters

    • callbackfn: function
        • (previousValue: ProtectionContainerResource, currentValue: ProtectionContainerResource, currentIndex: number, array: ProtectionContainerResource[]): ProtectionContainerResource

        • Parameters

          • previousValue: ProtectionContainerResource
          • currentValue: ProtectionContainerResource
          • currentIndex: number
          • array: ProtectionContainerResource[]

          Returns ProtectionContainerResource

    • initialValue: ProtectionContainerResource

    Returns ProtectionContainerResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ProtectionContainerResource, currentIndex: number, array: ProtectionContainerResource[]): U

        • Parameters

          • previousValue: U
          • currentValue: ProtectionContainerResource
          • currentIndex: number
          • array: ProtectionContainerResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ProtectionContainerResource[]

  • Reverses the elements in an Array.

    Returns ProtectionContainerResource[]

shift

  • shift(): ProtectionContainerResource | undefined

  • Removes the first element from an array and returns it.

    Returns ProtectionContainerResource | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ProtectionContainerResource[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ProtectionContainerResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ProtectionContainerResource, index: number, array: ProtectionContainerResource[]): boolean

        • Parameters

          • value: ProtectionContainerResource
          • index: number
          • array: ProtectionContainerResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ProtectionContainerResource[]
  • splice(start: number, deleteCount: number, ...items: ProtectionContainerResource[]): ProtectionContainerResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ProtectionContainerResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ProtectionContainerResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns ProtectionContainerResource[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ProtectionContainerResource[]): number

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ProtectionContainerResource[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ProtectionContainerResource>

  • Returns an iterable of values in the array

    Returns IterableIterator<ProtectionContainerResource>

type

type: object

className

className: string = "ProtectionContainerResourceList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ProtectionContainerResource"

name

name: "Composite" = "Composite"

Const ProtectionIntent

ProtectionIntent: object
interface

An interface representing ProtectionIntent. Base class for backup ProtectionIntent.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Type of backup managemenent for the backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional itemId

itemId: undefined | string
member

{string} [itemId] ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId

Optional policyId

policyId: undefined | string
member

{string} [policyId] ID of the backup policy with which this item is backed up.

protectionIntentItemType

protectionIntentItemType: "ProtectionIntent"
member

{string} protectionIntentItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionStatus
member

{ProtectionStatus} [protectionState] Backup state of this backup item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "ProtectionIntent"

Optional sourceResourceId

sourceResourceId: undefined | string
member

{string} [sourceResourceId] ARM ID of the resource to be backed up.

type

type: object

className

className: string = "ProtectionIntent"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ProtectionIntent"

modelProperties

modelProperties: object

backupManagementType

backupManagementType: object

serializedName

serializedName: string = "backupManagementType"

type

type: object

name

name: "String" = "String"

itemId

itemId: object

serializedName

serializedName: string = "itemId"

type

type: object

name

name: "String" = "String"

policyId

policyId: object

serializedName

serializedName: string = "policyId"

type

type: object

name

name: "String" = "String"

protectionIntentItemType

protectionIntentItemType: object

required

required: true = true

serializedName

serializedName: string = "protectionIntentItemType"

type

type: object

name

name: "String" = "String"

protectionState

protectionState: object

serializedName

serializedName: string = "protectionState"

type

type: object

name

name: "String" = "String"

sourceResourceId

sourceResourceId: object

serializedName

serializedName: string = "sourceResourceId"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "protectionIntentItemType"

serializedName

serializedName: string = "protectionIntentItemType"

Const ProtectionIntentQueryObject

ProtectionIntentQueryObject: object
interface

An interface representing ProtectionIntentQueryObject. Filters to list protection intent.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Backup management type for the backed up item. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional itemName

itemName: undefined | string
member

{string} [itemName] Item name of the intent

Optional itemType

itemType: IntentItemType
member

{IntentItemType} [itemType] Type of workload this item represents. Possible values include: 'Invalid', 'SQLInstance', 'SQLAvailabilityGroupContainer'

Optional parentName

parentName: undefined | string
member

{string} [parentName] Parent name of the intent

serializedName

serializedName: string = "ProtectionIntentQueryObject"

type

type: object

className

className: string = "ProtectionIntentQueryObject"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupManagementType

backupManagementType: object

serializedName

serializedName: string = "backupManagementType"

type

type: object

name

name: "String" = "String"

itemName

itemName: object

serializedName

serializedName: string = "itemName"

type

type: object

name

name: "String" = "String"

itemType

itemType: object

serializedName

serializedName: string = "itemType"

type

type: object

name

name: "String" = "String"

parentName

parentName: object

serializedName

serializedName: string = "parentName"

type

type: object

name

name: "String" = "String"

Const ProtectionIntentResource

ProtectionIntentResource: object
interface

An interface representing ProtectionIntentResource. Base class for backup ProtectionIntent.

extends

Resource

Optional eTag

eTag: undefined | string
member

{string} [eTag] Optional ETag.

Optional id

id: undefined | string
member

{string} [id] Resource Id represents the complete path to the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource location.

Optional name

name: undefined | string
member

{string} [name] Resource name associated with the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: ProtectionIntentUnion
member

{ProtectionIntentUnion} [properties] ProtectionIntentResource properties

serializedName

serializedName: string = "ProtectionIntentResource"

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

type

type: object

className

className: string = "ProtectionIntentResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "ProtectionIntent"

name

name: "Composite" = "Composite"

Const ProtectionIntentResourceList

ProtectionIntentResourceList: object
interface

An interface representing the ProtectionIntentResourceList. List of ProtectionIntent resources

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "ProtectionIntentResourceList"

__@iterator

  • __@iterator(): IterableIterator<ProtectionIntentResource>

  • Iterator

    Returns IterableIterator<ProtectionIntentResource>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ProtectionIntentResource>[]): ProtectionIntentResource[]
  • concat(...items: (T | ConcatArray<T>)[]): ProtectionIntentResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ProtectionIntentResource>[]

      Additional items to add to the end of array1.

    Returns ProtectionIntentResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ProtectionIntentResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ProtectionIntentResource]>

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ProtectionIntentResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ProtectionIntentResource, index: number, array: ProtectionIntentResource[]): boolean

        • Parameters

          • value: ProtectionIntentResource
          • index: number
          • array: ProtectionIntentResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ProtectionIntentResource, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ProtectionIntentResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ProtectionIntentResource[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ProtectionIntentResource

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ProtectionIntentResource, index: number, array: ProtectionIntentResource[]): boolean

        • Parameters

          • value: ProtectionIntentResource
          • index: number
          • array: ProtectionIntentResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ProtectionIntentResource, index: number, array: ProtectionIntentResource[]): any

        • Parameters

          • value: ProtectionIntentResource
          • index: number
          • array: ProtectionIntentResource[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ProtectionIntentResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ProtectionIntentResource | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ProtectionIntentResource

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ProtectionIntentResource, index: number, obj: ProtectionIntentResource[]): boolean

        • Parameters

          • this: void
          • value: ProtectionIntentResource
          • index: number
          • obj: ProtectionIntentResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ProtectionIntentResource, index: number, obj: ProtectionIntentResource[]): boolean

        • Parameters

          • value: ProtectionIntentResource
          • index: number
          • obj: ProtectionIntentResource[]

          Returns boolean

    • Optional thisArg: any

    Returns ProtectionIntentResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ProtectionIntentResource, index: number, obj: ProtectionIntentResource[]): boolean

        • Parameters

          • value: ProtectionIntentResource
          • index: number
          • obj: ProtectionIntentResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ProtectionIntentResource, index: number, array: ProtectionIntentResource[]): void

        • Parameters

          • value: ProtectionIntentResource
          • index: number
          • array: ProtectionIntentResource[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ProtectionIntentResource, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ProtectionIntentResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ProtectionIntentResource, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ProtectionIntentResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ProtectionIntentResource, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ProtectionIntentResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ProtectionIntentResource, index: number, array: ProtectionIntentResource[]): U

        • Parameters

          • value: ProtectionIntentResource
          • index: number
          • array: ProtectionIntentResource[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ProtectionIntentResource | undefined

  • Removes the last element from an array and returns it.

    Returns ProtectionIntentResource | undefined

push

  • push(...items: ProtectionIntentResource[]): number

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ProtectionIntentResource[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ProtectionIntentResource
  • reduce(callbackfn: function, initialValue: ProtectionIntentResource): ProtectionIntentResource
  • reduce<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ProtectionIntentResource, currentValue: ProtectionIntentResource, currentIndex: number, array: ProtectionIntentResource[]): ProtectionIntentResource

        • Parameters

          • previousValue: ProtectionIntentResource
          • currentValue: ProtectionIntentResource
          • currentIndex: number
          • array: ProtectionIntentResource[]

          Returns ProtectionIntentResource

    Returns ProtectionIntentResource

  • Parameters

    • callbackfn: function
        • (previousValue: ProtectionIntentResource, currentValue: ProtectionIntentResource, currentIndex: number, array: ProtectionIntentResource[]): ProtectionIntentResource

        • Parameters

          • previousValue: ProtectionIntentResource
          • currentValue: ProtectionIntentResource
          • currentIndex: number
          • array: ProtectionIntentResource[]

          Returns ProtectionIntentResource

    • initialValue: ProtectionIntentResource

    Returns ProtectionIntentResource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ProtectionIntentResource, currentIndex: number, array: ProtectionIntentResource[]): U

        • Parameters

          • previousValue: U
          • currentValue: ProtectionIntentResource
          • currentIndex: number
          • array: ProtectionIntentResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ProtectionIntentResource
  • reduceRight(callbackfn: function, initialValue: ProtectionIntentResource): ProtectionIntentResource
  • reduceRight<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ProtectionIntentResource, currentValue: ProtectionIntentResource, currentIndex: number, array: ProtectionIntentResource[]): ProtectionIntentResource

        • Parameters

          • previousValue: ProtectionIntentResource
          • currentValue: ProtectionIntentResource
          • currentIndex: number
          • array: ProtectionIntentResource[]

          Returns ProtectionIntentResource

    Returns ProtectionIntentResource

  • Parameters

    • callbackfn: function
        • (previousValue: ProtectionIntentResource, currentValue: ProtectionIntentResource, currentIndex: number, array: ProtectionIntentResource[]): ProtectionIntentResource

        • Parameters

          • previousValue: ProtectionIntentResource
          • currentValue: ProtectionIntentResource
          • currentIndex: number
          • array: ProtectionIntentResource[]

          Returns ProtectionIntentResource

    • initialValue: ProtectionIntentResource

    Returns ProtectionIntentResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ProtectionIntentResource, currentIndex: number, array: ProtectionIntentResource[]): U

        • Parameters

          • previousValue: U
          • currentValue: ProtectionIntentResource
          • currentIndex: number
          • array: ProtectionIntentResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ProtectionIntentResource[]

  • Reverses the elements in an Array.

    Returns ProtectionIntentResource[]

shift

  • shift(): ProtectionIntentResource | undefined

  • Removes the first element from an array and returns it.

    Returns ProtectionIntentResource | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ProtectionIntentResource[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ProtectionIntentResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ProtectionIntentResource, index: number, array: ProtectionIntentResource[]): boolean

        • Parameters

          • value: ProtectionIntentResource
          • index: number
          • array: ProtectionIntentResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ProtectionIntentResource[]
  • splice(start: number, deleteCount: number, ...items: ProtectionIntentResource[]): ProtectionIntentResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ProtectionIntentResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ProtectionIntentResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns ProtectionIntentResource[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ProtectionIntentResource[]): number

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ProtectionIntentResource[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ProtectionIntentResource>

  • Returns an iterable of values in the array

    Returns IterableIterator<ProtectionIntentResource>

type

type: object

className

className: string = "ProtectionIntentResourceList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ProtectionIntentResource"

name

name: "Composite" = "Composite"

Const ProtectionPolicy

ProtectionPolicy: object
interface

An interface representing ProtectionPolicy. Base class for backup policy. Workload-specific backup policies are derived from this class.

backupManagementType

backupManagementType: "ProtectionPolicy"
member

{string} backupManagementType Polymorphic Discriminator

Optional protectedItemsCount

protectedItemsCount: undefined | number
member

{number} [protectedItemsCount] Number of items associated with this policy.

serializedName

serializedName: string = "ProtectionPolicy"

type

type: object

className

className: string = "ProtectionPolicy"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ProtectionPolicy"

modelProperties

modelProperties: object

backupManagementType

backupManagementType: object

required

required: true = true

serializedName

serializedName: string = "backupManagementType"

type

type: object

name

name: "String" = "String"

protectedItemsCount

protectedItemsCount: object

serializedName

serializedName: string = "protectedItemsCount"

type

type: object

name

name: "Number" = "Number"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "backupManagementType"

serializedName

serializedName: string = "backupManagementType"

Const ProtectionPolicyQueryObject

ProtectionPolicyQueryObject: object
interface

An interface representing ProtectionPolicyQueryObject. Filters the list backup policies API.

Optional backupManagementType

backupManagementType: BackupManagementType
member

{BackupManagementType} [backupManagementType] Backup management type for the backup policy. Possible values include: 'Invalid', 'AzureIaasVM', 'MAB', 'DPM', 'AzureBackupServer', 'AzureSql', 'AzureStorage', 'AzureWorkload', 'DefaultBackup'

Optional fabricName

fabricName: undefined | string
member

{string} [fabricName] Fabric name for filter

serializedName

serializedName: string = "ProtectionPolicyQueryObject"

Optional workloadType

workloadType: WorkloadType
member

{WorkloadType} [workloadType] Workload type for the backup policy. Possible values include: 'Invalid', 'VM', 'FileFolder', 'AzureSqlDb', 'SQLDB', 'Exchange', 'Sharepoint', 'VMwareVM', 'SystemState', 'Client', 'GenericDataSource', 'SQLDataBase', 'AzureFileShare', 'SAPHanaDatabase'

type

type: object

className

className: string = "ProtectionPolicyQueryObject"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupManagementType

backupManagementType: object

serializedName

serializedName: string = "backupManagementType"

type

type: object

name

name: "String" = "String"

fabricName

fabricName: object

serializedName

serializedName: string = "fabricName"

type

type: object

name

name: "String" = "String"

workloadType

workloadType: object

serializedName

serializedName: string = "workloadType"

type

type: object

name

name: "String" = "String"

Const ProtectionPolicyResource

ProtectionPolicyResource: object
interface

An interface representing ProtectionPolicyResource. Base class for backup policy. Workload-specific backup policies are derived from this class.

extends

Resource

Optional eTag

eTag: undefined | string
member

{string} [eTag] Optional ETag.

Optional id

id: undefined | string
member

{string} [id] Resource Id represents the complete path to the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource location.

Optional name

name: undefined | string
member

{string} [name] Resource name associated with the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: ProtectionPolicyUnion
member

{ProtectionPolicyUnion} [properties] ProtectionPolicyResource properties

serializedName

serializedName: string = "ProtectionPolicyResource"

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

type

type: object

className

className: string = "ProtectionPolicyResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "ProtectionPolicy"

name

name: "Composite" = "Composite"

Const ProtectionPolicyResourceList

ProtectionPolicyResourceList: object
interface

An interface representing the ProtectionPolicyResourceList. List of ProtectionPolicy resources

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "ProtectionPolicyResourceList"

__@iterator

  • __@iterator(): IterableIterator<ProtectionPolicyResource>

  • Iterator

    Returns IterableIterator<ProtectionPolicyResource>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ProtectionPolicyResource>[]): ProtectionPolicyResource[]
  • concat(...items: (T | ConcatArray<T>)[]): ProtectionPolicyResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ProtectionPolicyResource>[]

      Additional items to add to the end of array1.

    Returns ProtectionPolicyResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ProtectionPolicyResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ProtectionPolicyResource]>

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ProtectionPolicyResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ProtectionPolicyResource, index: number, array: ProtectionPolicyResource[]): boolean

        • Parameters

          • value: ProtectionPolicyResource
          • index: number
          • array: ProtectionPolicyResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ProtectionPolicyResource, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ProtectionPolicyResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ProtectionPolicyResource[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ProtectionPolicyResource

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ProtectionPolicyResource, index: number, array: ProtectionPolicyResource[]): boolean

        • Parameters

          • value: ProtectionPolicyResource
          • index: number
          • array: ProtectionPolicyResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ProtectionPolicyResource, index: number, array: ProtectionPolicyResource[]): any

        • Parameters

          • value: ProtectionPolicyResource
          • index: number
          • array: ProtectionPolicyResource[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ProtectionPolicyResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ProtectionPolicyResource | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ProtectionPolicyResource

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ProtectionPolicyResource, index: number, obj: ProtectionPolicyResource[]): boolean

        • Parameters

          • this: void
          • value: ProtectionPolicyResource
          • index: number
          • obj: ProtectionPolicyResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ProtectionPolicyResource, index: number, obj: ProtectionPolicyResource[]): boolean

        • Parameters

          • value: ProtectionPolicyResource
          • index: number
          • obj: ProtectionPolicyResource[]

          Returns boolean

    • Optional thisArg: any

    Returns ProtectionPolicyResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ProtectionPolicyResource, index: number, obj: ProtectionPolicyResource[]): boolean

        • Parameters

          • value: ProtectionPolicyResource
          • index: number
          • obj: ProtectionPolicyResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ProtectionPolicyResource, index: number, array: ProtectionPolicyResource[]): void

        • Parameters

          • value: ProtectionPolicyResource
          • index: number
          • array: ProtectionPolicyResource[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ProtectionPolicyResource, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ProtectionPolicyResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ProtectionPolicyResource, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ProtectionPolicyResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ProtectionPolicyResource, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ProtectionPolicyResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ProtectionPolicyResource, index: number, array: ProtectionPolicyResource[]): U

        • Parameters

          • value: ProtectionPolicyResource
          • index: number
          • array: ProtectionPolicyResource[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ProtectionPolicyResource | undefined

  • Removes the last element from an array and returns it.

    Returns ProtectionPolicyResource | undefined

push

  • push(...items: ProtectionPolicyResource[]): number

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ProtectionPolicyResource[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ProtectionPolicyResource
  • reduce(callbackfn: function, initialValue: ProtectionPolicyResource): ProtectionPolicyResource
  • reduce<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ProtectionPolicyResource, currentValue: ProtectionPolicyResource, currentIndex: number, array: ProtectionPolicyResource[]): ProtectionPolicyResource

        • Parameters

          • previousValue: ProtectionPolicyResource
          • currentValue: ProtectionPolicyResource
          • currentIndex: number
          • array: ProtectionPolicyResource[]

          Returns ProtectionPolicyResource

    Returns ProtectionPolicyResource

  • Parameters

    • callbackfn: function
        • (previousValue: ProtectionPolicyResource, currentValue: ProtectionPolicyResource, currentIndex: number, array: ProtectionPolicyResource[]): ProtectionPolicyResource

        • Parameters

          • previousValue: ProtectionPolicyResource
          • currentValue: ProtectionPolicyResource
          • currentIndex: number
          • array: ProtectionPolicyResource[]

          Returns ProtectionPolicyResource

    • initialValue: ProtectionPolicyResource

    Returns ProtectionPolicyResource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ProtectionPolicyResource, currentIndex: number, array: ProtectionPolicyResource[]): U

        • Parameters

          • previousValue: U
          • currentValue: ProtectionPolicyResource
          • currentIndex: number
          • array: ProtectionPolicyResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ProtectionPolicyResource
  • reduceRight(callbackfn: function, initialValue: ProtectionPolicyResource): ProtectionPolicyResource
  • reduceRight<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ProtectionPolicyResource, currentValue: ProtectionPolicyResource, currentIndex: number, array: ProtectionPolicyResource[]): ProtectionPolicyResource

        • Parameters

          • previousValue: ProtectionPolicyResource
          • currentValue: ProtectionPolicyResource
          • currentIndex: number
          • array: ProtectionPolicyResource[]

          Returns ProtectionPolicyResource

    Returns ProtectionPolicyResource

  • Parameters

    • callbackfn: function
        • (previousValue: ProtectionPolicyResource, currentValue: ProtectionPolicyResource, currentIndex: number, array: ProtectionPolicyResource[]): ProtectionPolicyResource

        • Parameters

          • previousValue: ProtectionPolicyResource
          • currentValue: ProtectionPolicyResource
          • currentIndex: number
          • array: ProtectionPolicyResource[]

          Returns ProtectionPolicyResource

    • initialValue: ProtectionPolicyResource

    Returns ProtectionPolicyResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ProtectionPolicyResource, currentIndex: number, array: ProtectionPolicyResource[]): U

        • Parameters

          • previousValue: U
          • currentValue: ProtectionPolicyResource
          • currentIndex: number
          • array: ProtectionPolicyResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ProtectionPolicyResource[]

  • Reverses the elements in an Array.

    Returns ProtectionPolicyResource[]

shift

  • shift(): ProtectionPolicyResource | undefined

  • Removes the first element from an array and returns it.

    Returns ProtectionPolicyResource | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ProtectionPolicyResource[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ProtectionPolicyResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ProtectionPolicyResource, index: number, array: ProtectionPolicyResource[]): boolean

        • Parameters

          • value: ProtectionPolicyResource
          • index: number
          • array: ProtectionPolicyResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ProtectionPolicyResource[]
  • splice(start: number, deleteCount: number, ...items: ProtectionPolicyResource[]): ProtectionPolicyResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ProtectionPolicyResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ProtectionPolicyResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns ProtectionPolicyResource[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ProtectionPolicyResource[]): number

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ProtectionPolicyResource[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ProtectionPolicyResource>

  • Returns an iterable of values in the array

    Returns IterableIterator<ProtectionPolicyResource>

type

type: object

className

className: string = "ProtectionPolicyResourceList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ProtectionPolicyResource"

name

name: "Composite" = "Composite"

Const RecoveryPoint

RecoveryPoint: object
interface

An interface representing RecoveryPoint. Base class for backup copies. Workload-specific backup copies are derived from this class.

objectType

objectType: "RecoveryPoint"
member

{string} objectType Polymorphic Discriminator

serializedName

serializedName: string = "RecoveryPoint"

type

type: object

className

className: string = "RecoveryPoint"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "RecoveryPoint"

modelProperties

modelProperties: object

objectType

objectType: object

required

required: true = true

serializedName

serializedName: string = "objectType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "objectType"

serializedName

serializedName: string = "objectType"

Const RecoveryPointResource

RecoveryPointResource: object
interface

An interface representing RecoveryPointResource. Base class for backup copies. Workload-specific backup copies are derived from this class.

extends

Resource

Optional eTag

eTag: undefined | string
member

{string} [eTag] Optional ETag.

Optional id

id: undefined | string
member

{string} [id] Resource Id represents the complete path to the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource location.

Optional name

name: undefined | string
member

{string} [name] Resource name associated with the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: RecoveryPointUnion
member

{RecoveryPointUnion} [properties] RecoveryPointResource properties

serializedName

serializedName: string = "RecoveryPointResource"

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

type

type: object

className

className: string = "RecoveryPointResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "RecoveryPoint"

name

name: "Composite" = "Composite"

Const RecoveryPointResourceList

RecoveryPointResourceList: object
interface

An interface representing the RecoveryPointResourceList. List of RecoveryPoint resources

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "RecoveryPointResourceList"

__@iterator

  • __@iterator(): IterableIterator<RecoveryPointResource>

  • Iterator

    Returns IterableIterator<RecoveryPointResource>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<RecoveryPointResource>[]): RecoveryPointResource[]
  • concat(...items: (T | ConcatArray<T>)[]): RecoveryPointResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<RecoveryPointResource>[]

      Additional items to add to the end of array1.

    Returns RecoveryPointResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RecoveryPointResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, RecoveryPointResource]>

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RecoveryPointResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: RecoveryPointResource, index: number, array: RecoveryPointResource[]): boolean

        • Parameters

          • value: RecoveryPointResource
          • index: number
          • array: RecoveryPointResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: RecoveryPointResource, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RecoveryPointResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): RecoveryPointResource[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: RecoveryPointResource

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RecoveryPointResource, index: number, array: RecoveryPointResource[]): boolean

        • Parameters

          • value: RecoveryPointResource
          • index: number
          • array: RecoveryPointResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: RecoveryPointResource, index: number, array: RecoveryPointResource[]): any

        • Parameters

          • value: RecoveryPointResource
          • index: number
          • array: RecoveryPointResource[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns RecoveryPointResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): RecoveryPointResource | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: RecoveryPointResource

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: RecoveryPointResource, index: number, obj: RecoveryPointResource[]): boolean

        • Parameters

          • this: void
          • value: RecoveryPointResource
          • index: number
          • obj: RecoveryPointResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: RecoveryPointResource, index: number, obj: RecoveryPointResource[]): boolean

        • Parameters

          • value: RecoveryPointResource
          • index: number
          • obj: RecoveryPointResource[]

          Returns boolean

    • Optional thisArg: any

    Returns RecoveryPointResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: RecoveryPointResource, index: number, obj: RecoveryPointResource[]): boolean

        • Parameters

          • value: RecoveryPointResource
          • index: number
          • obj: RecoveryPointResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: RecoveryPointResource, index: number, array: RecoveryPointResource[]): void

        • Parameters

          • value: RecoveryPointResource
          • index: number
          • array: RecoveryPointResource[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: RecoveryPointResource, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RecoveryPointResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: RecoveryPointResource, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RecoveryPointResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: RecoveryPointResource, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RecoveryPointResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: RecoveryPointResource, index: number, array: RecoveryPointResource[]): U

        • Parameters

          • value: RecoveryPointResource
          • index: number
          • array: RecoveryPointResource[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): RecoveryPointResource | undefined

  • Removes the last element from an array and returns it.

    Returns RecoveryPointResource | undefined

push

  • push(...items: RecoveryPointResource[]): number

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: RecoveryPointResource[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): RecoveryPointResource
  • reduce(callbackfn: function, initialValue: RecoveryPointResource): RecoveryPointResource
  • reduce<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: RecoveryPointResource, currentValue: RecoveryPointResource, currentIndex: number, array: RecoveryPointResource[]): RecoveryPointResource

        • Parameters

          • previousValue: RecoveryPointResource
          • currentValue: RecoveryPointResource
          • currentIndex: number
          • array: RecoveryPointResource[]

          Returns RecoveryPointResource

    Returns RecoveryPointResource

  • Parameters

    • callbackfn: function
        • (previousValue: RecoveryPointResource, currentValue: RecoveryPointResource, currentIndex: number, array: RecoveryPointResource[]): RecoveryPointResource

        • Parameters

          • previousValue: RecoveryPointResource
          • currentValue: RecoveryPointResource
          • currentIndex: number
          • array: RecoveryPointResource[]

          Returns RecoveryPointResource

    • initialValue: RecoveryPointResource

    Returns RecoveryPointResource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RecoveryPointResource, currentIndex: number, array: RecoveryPointResource[]): U

        • Parameters

          • previousValue: U
          • currentValue: RecoveryPointResource
          • currentIndex: number
          • array: RecoveryPointResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): RecoveryPointResource
  • reduceRight(callbackfn: function, initialValue: RecoveryPointResource): RecoveryPointResource
  • reduceRight<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: RecoveryPointResource, currentValue: RecoveryPointResource, currentIndex: number, array: RecoveryPointResource[]): RecoveryPointResource

        • Parameters

          • previousValue: RecoveryPointResource
          • currentValue: RecoveryPointResource
          • currentIndex: number
          • array: RecoveryPointResource[]

          Returns RecoveryPointResource

    Returns RecoveryPointResource

  • Parameters

    • callbackfn: function
        • (previousValue: RecoveryPointResource, currentValue: RecoveryPointResource, currentIndex: number, array: RecoveryPointResource[]): RecoveryPointResource

        • Parameters

          • previousValue: RecoveryPointResource
          • currentValue: RecoveryPointResource
          • currentIndex: number
          • array: RecoveryPointResource[]

          Returns RecoveryPointResource

    • initialValue: RecoveryPointResource

    Returns RecoveryPointResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: RecoveryPointResource, currentIndex: number, array: RecoveryPointResource[]): U

        • Parameters

          • previousValue: U
          • currentValue: RecoveryPointResource
          • currentIndex: number
          • array: RecoveryPointResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): RecoveryPointResource[]

  • Reverses the elements in an Array.

    Returns RecoveryPointResource[]

shift

  • shift(): RecoveryPointResource | undefined

  • Removes the first element from an array and returns it.

    Returns RecoveryPointResource | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): RecoveryPointResource[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RecoveryPointResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: RecoveryPointResource, index: number, array: RecoveryPointResource[]): boolean

        • Parameters

          • value: RecoveryPointResource
          • index: number
          • array: RecoveryPointResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): RecoveryPointResource[]
  • splice(start: number, deleteCount: number, ...items: RecoveryPointResource[]): RecoveryPointResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RecoveryPointResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RecoveryPointResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns RecoveryPointResource[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: RecoveryPointResource[]): number

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: RecoveryPointResource[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<RecoveryPointResource>

  • Returns an iterable of values in the array

    Returns IterableIterator<RecoveryPointResource>

type

type: object

className

className: string = "RecoveryPointResourceList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecoveryPointResource"

name

name: "Composite" = "Composite"

Const RecoveryPointTierInformation

RecoveryPointTierInformation: object
interface

An interface representing RecoveryPointTierInformation. Recovery point tier information.

serializedName

serializedName: string = "RecoveryPointTierInformation"

Optional status

status: RecoveryPointTierStatus
member

{RecoveryPointTierStatus} [status] Recovery point tier status. Possible values include: 'Invalid', 'Valid', 'Disabled', 'Deleted'

type

type: object
member

{RecoveryPointTierType} [type] Recovery point tier type. Possible values include: 'Invalid', 'InstantRP', 'HardenedRP'

className

className: string = "RecoveryPointTierInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

status

status: object

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["Invalid","Valid","Disabled","Deleted"]

name

name: "Enum" = "Enum"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

allowedValues

allowedValues: string[] = ["Invalid","InstantRP","HardenedRP"]

name

name: "Enum" = "Enum"

Const Resource

Resource: object
interface

An interface representing Resource. ARM Resource.

extends

BaseResource

Optional eTag

eTag: undefined | string
member

{string} [eTag] Optional ETag.

Optional id

id: undefined | string
member

{string} [id] Resource Id represents the complete path to the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource location.

Optional name

name: undefined | string
member

{string} [name] Resource name associated with the resource. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Resource"

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

type

type: object
member

{string} [type] Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Resource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eTag

eTag: object

serializedName

serializedName: string = "eTag"

type

type: object

name

name: "String" = "String"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ResourceList

ResourceList: object
interface

An interface representing ResourceList. Base for all lists of resources.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.

serializedName

serializedName: string = "ResourceList"

type

type: object

className

className: string = "ResourceList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

Const RestoreFileSpecs

RestoreFileSpecs: object
interface

An interface representing RestoreFileSpecs. Restore file specs like file path, type and target folder path info.

Optional fileSpecType

fileSpecType: undefined | string
member

{string} [fileSpecType] Indicates what the Path variable stands for

Optional path

path: undefined | string
member

{string} [path] Source File/Folder path

serializedName

serializedName: string = "RestoreFileSpecs"

Optional targetFolderPath

targetFolderPath: undefined | string
member

{string} [targetFolderPath] Destination folder path in target FileShare

type

type: object

className

className: string = "RestoreFileSpecs"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

fileSpecType

fileSpecType: object

serializedName

serializedName: string = "fileSpecType"

type

type: object

name

name: "String" = "String"

path

path: object

serializedName

serializedName: string = "path"

type

type: object

name

name: "String" = "String"

targetFolderPath

targetFolderPath: object

serializedName

serializedName: string = "targetFolderPath"

type

type: object

name

name: "String" = "String"

Const RestoreRequest

RestoreRequest: object
interface

An interface representing RestoreRequest. Base class for restore request. Workload-specific restore requests are derived from this class.

objectType

objectType: "RestoreRequest"
member

{string} objectType Polymorphic Discriminator

serializedName

serializedName: string = "RestoreRequest"

type

type: object

className

className: string = "RestoreRequest"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "RestoreRequest"

modelProperties

modelProperties: object

objectType

objectType: object

required

required: true = true

serializedName

serializedName: string = "objectType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "objectType"

serializedName

serializedName: string = "objectType"

Const RestoreRequestResource

RestoreRequestResource: object
interface

An interface representing RestoreRequestResource. Base class for restore request. Workload-specific restore requests are derived from this class.

extends

Resource

Optional eTag

eTag: undefined | string
member

{string} [eTag] Optional ETag.

Optional id

id: undefined | string
member

{string} [id] Resource Id represents the complete path to the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource location.

Optional name

name: undefined | string
member

{string} [name] Resource name associated with the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: RestoreRequestUnion
member

{RestoreRequestUnion} [properties] RestoreRequestResource properties

serializedName

serializedName: string = "RestoreRequestResource"

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

type

type: object

className

className: string = "RestoreRequestResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "RestoreRequest"

name

name: "Composite" = "Composite"

Const RetentionDuration

RetentionDuration: object
interface

An interface representing RetentionDuration. Retention duration.

Optional count

count: undefined | number
member

{number} [count] Count of duration types. Retention duration is obtained by the counting the duration type Count times. For example, when Count = 3 and DurationType = Weeks, retention duration will be three weeks.

Optional durationType

durationType: RetentionDurationType
member

{RetentionDurationType} [durationType] Retention duration type of retention policy. Possible values include: 'Invalid', 'Days', 'Weeks', 'Months', 'Years'

serializedName

serializedName: string = "RetentionDuration"

type

type: object

className

className: string = "RetentionDuration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

count

count: object

serializedName

serializedName: string = "count"

type

type: object

name

name: "Number" = "Number"

durationType

durationType: object

serializedName

serializedName: string = "durationType"

type

type: object

name

name: "String" = "String"

Const RetentionPolicy

RetentionPolicy: object
interface

An interface representing RetentionPolicy. Base class for retention policy.

retentionPolicyType

retentionPolicyType: "RetentionPolicy"
member

{string} retentionPolicyType Polymorphic Discriminator

serializedName

serializedName: string = "RetentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "RetentionPolicy"

modelProperties

modelProperties: object

retentionPolicyType

retentionPolicyType: object

required

required: true = true

serializedName

serializedName: string = "retentionPolicyType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "retentionPolicyType"

serializedName

serializedName: string = "retentionPolicyType"

Const SQLDataDirectory

SQLDataDirectory: object
interface

An interface representing SQLDataDirectory. SQLDataDirectory info

Optional logicalName

logicalName: undefined | string
member

{string} [logicalName] Logical name of the file

Optional path

path: undefined | string
member

{string} [path] File path

serializedName

serializedName: string = "SQLDataDirectory"

type

type: object
member

{SQLDataDirectoryType} [type] Type of data directory mapping. Possible values include: 'Invalid', 'Data', 'Log'

className

className: string = "SQLDataDirectory"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

logicalName

logicalName: object

serializedName

serializedName: string = "logicalName"

type

type: object

name

name: "String" = "String"

path

path: object

serializedName

serializedName: string = "path"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const SQLDataDirectoryMapping

SQLDataDirectoryMapping: object
interface

An interface representing SQLDataDirectoryMapping. Encapsulates information regarding data directory

Optional mappingType

mappingType: SQLDataDirectoryType
member

{SQLDataDirectoryType} [mappingType] Type of data directory mapping. Possible values include: 'Invalid', 'Data', 'Log'

serializedName

serializedName: string = "SQLDataDirectoryMapping"

Optional sourceLogicalName

sourceLogicalName: undefined | string
member

{string} [sourceLogicalName] Restore source logical name path

Optional sourcePath

sourcePath: undefined | string
member

{string} [sourcePath] Restore source path

Optional targetPath

targetPath: undefined | string
member

{string} [targetPath] Target path

type

type: object

className

className: string = "SQLDataDirectoryMapping"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

mappingType

mappingType: object

serializedName

serializedName: string = "mappingType"

type

type: object

name

name: "String" = "String"

sourceLogicalName

sourceLogicalName: object

serializedName

serializedName: string = "sourceLogicalName"

type

type: object

name

name: "String" = "String"

sourcePath

sourcePath: object

serializedName

serializedName: string = "sourcePath"

type

type: object

name

name: "String" = "String"

targetPath

targetPath: object

serializedName

serializedName: string = "targetPath"

type

type: object

name

name: "String" = "String"

Const SchedulePolicy

SchedulePolicy: object
interface

An interface representing SchedulePolicy. Base class for backup schedule.

schedulePolicyType

schedulePolicyType: "SchedulePolicy"
member

{string} schedulePolicyType Polymorphic Discriminator

serializedName

serializedName: string = "SchedulePolicy"

type

type: object

className

className: string = "SchedulePolicy"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "SchedulePolicy"

modelProperties

modelProperties: object

schedulePolicyType

schedulePolicyType: object

required

required: true = true

serializedName

serializedName: string = "schedulePolicyType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "schedulePolicyType"

serializedName

serializedName: string = "schedulePolicyType"

Const Settings

Settings: object
interface

An interface representing Settings. Common settings field for backup management

Optional isCompression

isCompression: undefined | false | true
member

{boolean} [isCompression] Workload compression flag. This has been added so that 'isSqlCompression' will be deprecated once clients upgrade to consider this flag.

Optional issqlcompression

issqlcompression: undefined | false | true
member

{boolean} [issqlcompression] SQL compression flag

serializedName

serializedName: string = "Settings"

Optional timeZone

timeZone: undefined | string
member

{string} [timeZone] TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time".

type

type: object

className

className: string = "Settings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

isCompression

isCompression: object

serializedName

serializedName: string = "isCompression"

type

type: object

name

name: "Boolean" = "Boolean"

issqlcompression

issqlcompression: object

serializedName

serializedName: string = "issqlcompression"

type

type: object

name

name: "Boolean" = "Boolean"

timeZone

timeZone: object

serializedName

serializedName: string = "timeZone"

type

type: object

name

name: "String" = "String"

Const SimpleRetentionPolicy

SimpleRetentionPolicy: object
interface

An interface representing SimpleRetentionPolicy. Simple policy retention.

Optional retentionDuration

retentionDuration: RetentionDuration
member

{RetentionDuration} [retentionDuration] Retention duration of the protection policy.

retentionPolicyType

retentionPolicyType: "SimpleRetentionPolicy"
member

{string} retentionPolicyType Polymorphic Discriminator

serializedName

serializedName: string = "SimpleRetentionPolicy"

type

type: object

className

className: string = "SimpleRetentionPolicy"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = RetentionPolicy.type.polymorphicDiscriminator

uberParent

uberParent: string = "RetentionPolicy"

modelProperties

modelProperties: object

retentionDuration

retentionDuration: object

serializedName

serializedName: string = "retentionDuration"

type

type: object

className

className: string = "RetentionDuration"

name

name: "Composite" = "Composite"

Const SimpleSchedulePolicy

SimpleSchedulePolicy: object
interface

An interface representing SimpleSchedulePolicy. Simple policy schedule.

schedulePolicyType

schedulePolicyType: "SimpleSchedulePolicy"
member

{string} schedulePolicyType Polymorphic Discriminator

Optional scheduleRunDays

scheduleRunDays: DayOfWeek[]
member

{DayOfWeek[]} [scheduleRunDays] List of days of week this schedule has to be run.

Optional scheduleRunFrequency

scheduleRunFrequency: ScheduleRunType
member

{ScheduleRunType} [scheduleRunFrequency] Frequency of the schedule operation of this policy. Possible values include: 'Invalid', 'Daily', 'Weekly'

Optional scheduleRunTimes

scheduleRunTimes: Date[] | string[]
member

{Date[] | string[]} [scheduleRunTimes] List of times of day this schedule has to be run.

Optional scheduleWeeklyFrequency

scheduleWeeklyFrequency: undefined | number
member

{number} [scheduleWeeklyFrequency] At every number weeks this schedule has to be run.

serializedName

serializedName: string = "SimpleSchedulePolicy"

type

type: object

className

className: string = "SimpleSchedulePolicy"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = SchedulePolicy.type.polymorphicDiscriminator

uberParent

uberParent: string = "SchedulePolicy"

modelProperties

modelProperties: object

scheduleRunDays

scheduleRunDays: object

serializedName

serializedName: string = "scheduleRunDays"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]

name

name: "Enum" = "Enum"

scheduleRunFrequency

scheduleRunFrequency: object

serializedName

serializedName: string = "scheduleRunFrequency"

type

type: object

name

name: "String" = "String"

scheduleRunTimes

scheduleRunTimes: object

serializedName

serializedName: string = "scheduleRunTimes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "DateTime" = "DateTime"

scheduleWeeklyFrequency

scheduleWeeklyFrequency: object

serializedName

serializedName: string = "scheduleWeeklyFrequency"

type

type: object

name

name: "Number" = "Number"

Const SubProtectionPolicy

SubProtectionPolicy: object
interface

An interface representing SubProtectionPolicy. Sub-protection policy which includes schedule and retention

Optional policyType

policyType: PolicyType
member

{PolicyType} [policyType] Type of backup policy type. Possible values include: 'Invalid', 'Full', 'Differential', 'Log', 'CopyOnlyFull'

Optional retentionPolicy

retentionPolicy: RetentionPolicyUnion
member

{RetentionPolicyUnion} [retentionPolicy] Retention policy with the details on backup copy retention ranges.

Optional schedulePolicy

schedulePolicy: SchedulePolicyUnion
member

{SchedulePolicyUnion} [schedulePolicy] Backup schedule specified as part of backup policy.

serializedName

serializedName: string = "SubProtectionPolicy"

type

type: object

className

className: string = "SubProtectionPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

policyType

policyType: object

serializedName

serializedName: string = "policyType"

type

type: object

name

name: "String" = "String"

retentionPolicy

retentionPolicy: object

serializedName

serializedName: string = "retentionPolicy"

type

type: object

className

className: string = "RetentionPolicy"

name

name: "Composite" = "Composite"

schedulePolicy

schedulePolicy: object

serializedName

serializedName: string = "schedulePolicy"

type

type: object

className

className: string = "SchedulePolicy"

name

name: "Composite" = "Composite"

Const TargetAFSRestoreInfo

TargetAFSRestoreInfo: object
interface

An interface representing TargetAFSRestoreInfo. Target Azure File Share Info.

Optional name

name: undefined | string
member

{string} [name] File share name

serializedName

serializedName: string = "TargetAFSRestoreInfo"

Optional targetResourceId

targetResourceId: undefined | string
member

{string} [targetResourceId] Target file share resource ARM ID

type

type: object

className

className: string = "TargetAFSRestoreInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

targetResourceId

targetResourceId: object

serializedName

serializedName: string = "targetResourceId"

type

type: object

name

name: "String" = "String"

Const TargetRestoreInfo

TargetRestoreInfo: object
interface

An interface representing TargetRestoreInfo. Details about target workload during restore operation.

Optional containerId

containerId: undefined | string
member

{string} [containerId] Resource Id name of the container in which Target DataBase resides

Optional databaseName

databaseName: undefined | string
member

{string} [databaseName] Database name InstanceName/DataBaseName for SQL or System/DbName for SAP Hana

Optional overwriteOption

overwriteOption: OverwriteOptions
member

{OverwriteOptions} [overwriteOption] Can Overwrite if Target DataBase already exists. Possible values include: 'Invalid', 'FailOnConflict', 'Overwrite'

serializedName

serializedName: string = "TargetRestoreInfo"

type

type: object

className

className: string = "TargetRestoreInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

containerId

containerId: object

serializedName

serializedName: string = "containerId"

type

type: object

name

name: "String" = "String"

databaseName

databaseName: object

serializedName

serializedName: string = "databaseName"

type

type: object

name

name: "String" = "String"

overwriteOption

overwriteOption: object

serializedName

serializedName: string = "overwriteOption"

type

type: object

name

name: "String" = "String"

Const TokenInformation

TokenInformation: object
interface

An interface representing TokenInformation. The token information details.

Optional expiryTimeInUtcTicks

expiryTimeInUtcTicks: undefined | number
member

{number} [expiryTimeInUtcTicks] Expiry time of token.

Optional securityPIN

securityPIN: undefined | string
member

{string} [securityPIN] Security PIN

serializedName

serializedName: string = "TokenInformation"

Optional token

token: undefined | string
member

{string} [token] Token value.

type

type: object

className

className: string = "TokenInformation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

expiryTimeInUtcTicks

expiryTimeInUtcTicks: object

serializedName

serializedName: string = "expiryTimeInUtcTicks"

type

type: object

name

name: "Number" = "Number"

securityPIN

securityPIN: object

serializedName

serializedName: string = "securityPIN"

type

type: object

name

name: "String" = "String"

token

token: object

serializedName

serializedName: string = "token"

type

type: object

name

name: "String" = "String"

Const ValidateIaasVMRestoreOperationRequest

ValidateIaasVMRestoreOperationRequest: object
interface

An interface representing ValidateIaasVMRestoreOperationRequest. AzureRestoreValidation request.

objectType

objectType: "ValidateIaasVMRestoreOperationRequest"
member

{string} objectType Polymorphic Discriminator

Optional restoreRequest

restoreRequest: RestoreRequestUnion
member

{RestoreRequestUnion} [restoreRequest] Sets restore request to be validated

serializedName

serializedName: string = "ValidateIaasVMRestoreOperationRequest"

type

type: object

className

className: string = "ValidateIaasVMRestoreOperationRequest"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ValidateOperationRequest.type.polymorphicDiscriminator

uberParent

uberParent: string = "ValidateOperationRequest"

modelProperties

modelProperties: object

Const ValidateOperationRequest

ValidateOperationRequest: object
interface

An interface representing ValidateOperationRequest. Base class for validate operation request.

objectType

objectType: "ValidateOperationRequest"
member

{string} objectType Polymorphic Discriminator

serializedName

serializedName: string = "ValidateOperationRequest"

type

type: object

className

className: string = "ValidateOperationRequest"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "ValidateOperationRequest"

modelProperties

modelProperties: object

objectType

objectType: object

required

required: true = true

serializedName

serializedName: string = "objectType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "objectType"

serializedName

serializedName: string = "objectType"

Const ValidateOperationResponse

ValidateOperationResponse: object
interface

An interface representing ValidateOperationResponse. Base class for validate operation response.

serializedName

serializedName: string = "ValidateOperationResponse"

Optional validationResults

validationResults: ErrorDetail[]
member

{ErrorDetail[]} [validationResults] Gets the validation result

type

type: object

className

className: string = "ValidateOperationResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

validationResults

validationResults: object

serializedName

serializedName: string = "validationResults"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorDetail"

name

name: "Composite" = "Composite"

Const ValidateOperationsResponse

ValidateOperationsResponse: object
interface

An interface representing ValidateOperationsResponse.

serializedName

serializedName: string = "ValidateOperationsResponse"

Optional validateOperationResponse

validateOperationResponse: ValidateOperationResponse
member

{ValidateOperationResponse} [validateOperationResponse]

type

type: object

className

className: string = "ValidateOperationsResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

validateOperationResponse

validateOperationResponse: object

serializedName

serializedName: string = "validateOperationResponse"

type

type: object

className

className: string = "ValidateOperationResponse"

name

name: "Composite" = "Composite"

Const ValidateRestoreOperationRequest

ValidateRestoreOperationRequest: object
interface

An interface representing ValidateRestoreOperationRequest. AzureRestoreValidation request.

objectType

objectType: "ValidateRestoreOperationRequest"
member

{string} objectType Polymorphic Discriminator

Optional restoreRequest

restoreRequest: RestoreRequestUnion
member

{RestoreRequestUnion} [restoreRequest] Sets restore request to be validated

serializedName

serializedName: string = "ValidateRestoreOperationRequest"

type

type: object

className

className: string = "ValidateRestoreOperationRequest"

name

name: "Composite" = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: undefined | PolymorphicDiscriminator = ValidateOperationRequest.type.polymorphicDiscriminator

uberParent

uberParent: string = "ValidateOperationRequest"

modelProperties

modelProperties: object

restoreRequest

restoreRequest: object

serializedName

serializedName: string = "restoreRequest"

type

type: object

className

className: string = "RestoreRequest"

name

name: "Composite" = "Composite"

Const WeeklyRetentionFormat

WeeklyRetentionFormat: object
interface

An interface representing WeeklyRetentionFormat. Weekly retention format.

Optional daysOfTheWeek

daysOfTheWeek: DayOfWeek[]
member

{DayOfWeek[]} [daysOfTheWeek] List of days of the week.

serializedName

serializedName: string = "WeeklyRetentionFormat"

Optional weeksOfTheMonth

weeksOfTheMonth: WeekOfMonth[]
member

{WeekOfMonth[]} [weeksOfTheMonth] List of weeks of month.

type

type: object

className

className: string = "WeeklyRetentionFormat"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

daysOfTheWeek

daysOfTheWeek: object

serializedName

serializedName: string = "daysOfTheWeek"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]

name

name: "Enum" = "Enum"

weeksOfTheMonth

weeksOfTheMonth: object

serializedName

serializedName: string = "weeksOfTheMonth"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["First","Second","Third","Fourth","Last","Invalid"]

name

name: "Enum" = "Enum"

Const WeeklyRetentionSchedule

WeeklyRetentionSchedule: object
interface

An interface representing WeeklyRetentionSchedule. Weekly retention schedule.

Optional daysOfTheWeek

daysOfTheWeek: DayOfWeek[]
member

{DayOfWeek[]} [daysOfTheWeek] List of days of week for weekly retention policy.

Optional retentionDuration

retentionDuration: RetentionDuration
member

{RetentionDuration} [retentionDuration] Retention duration of retention Policy.

Optional retentionTimes

retentionTimes: Date[] | string[]
member

{Date[] | string[]} [retentionTimes] Retention times of retention policy.

serializedName

serializedName: string = "WeeklyRetentionSchedule"

type

type: object

className

className: string = "WeeklyRetentionSchedule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

daysOfTheWeek

daysOfTheWeek: object

serializedName

serializedName: string = "daysOfTheWeek"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]

name

name: "Enum" = "Enum"

retentionDuration

retentionDuration: object

serializedName

serializedName: string = "retentionDuration"

type

type: object

className

className: string = "RetentionDuration"

name

name: "Composite" = "Composite"

retentionTimes

retentionTimes: object

serializedName

serializedName: string = "retentionTimes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "DateTime" = "DateTime"

Const WorkloadInquiryDetails

WorkloadInquiryDetails: object
interface

An interface representing WorkloadInquiryDetails. Details of an inquired protectable item.

Optional inquiryValidation

inquiryValidation: InquiryValidation
member

{InquiryValidation} [inquiryValidation] Inquiry validation such as permissions and other backup validations.

Optional itemCount

itemCount: undefined | number
member

{number} [itemCount] Contains the protectable item Count inside this Container.

serializedName

serializedName: string = "WorkloadInquiryDetails"

type

type: object
member

{string} [type] Type of the Workload such as SQL, Oracle etc.

className

className: string = "WorkloadInquiryDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

inquiryValidation

inquiryValidation: object

serializedName

serializedName: string = "inquiryValidation"

type

type: object

className

className: string = "InquiryValidation"

name

name: "Composite" = "Composite"

itemCount

itemCount: object

serializedName

serializedName: string = "itemCount"

type

type: object

name

name: "Number" = "Number"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const WorkloadItem

WorkloadItem: object
interface

An interface representing WorkloadItem. Base class for backup item. Workload-specific backup items are derived from this class.

Optional backupManagementType

backupManagementType: undefined | string
member

{string} [backupManagementType] Type of backup managemenent to backup an item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the backup item.

Optional protectionState

protectionState: ProtectionStatus
member

{ProtectionStatus} [protectionState] State of the back up item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "WorkloadItem"

workloadItemType

workloadItemType: "WorkloadItem"
member

{string} workloadItemType Polymorphic Discriminator

Optional workloadType

workloadType: undefined | string
member

{string} [workloadType] Type of workload for the backup management

type

type: object

className

className: string = "WorkloadItem"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "WorkloadItem"

modelProperties

modelProperties: object

backupManagementType

backupManagementType: object

serializedName

serializedName: string = "backupManagementType"

type

type: object

name

name: "String" = "String"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

protectionState

protectionState: object

serializedName

serializedName: string = "protectionState"

type

type: object

name

name: "String" = "String"

workloadItemType

workloadItemType: object

required

required: true = true

serializedName

serializedName: string = "workloadItemType"

type

type: object

name

name: "String" = "String"

workloadType

workloadType: object

serializedName

serializedName: string = "workloadType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "workloadItemType"

serializedName

serializedName: string = "workloadItemType"

Const WorkloadItemResource

WorkloadItemResource: object
interface

An interface representing WorkloadItemResource. Base class for backup item. Workload-specific backup items are derived from this class.

extends

Resource

Optional eTag

eTag: undefined | string
member

{string} [eTag] Optional ETag.

Optional id

id: undefined | string
member

{string} [id] Resource Id represents the complete path to the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource location.

Optional name

name: undefined | string
member

{string} [name] Resource name associated with the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: WorkloadItemUnion
member

{WorkloadItemUnion} [properties] WorkloadItemResource properties

serializedName

serializedName: string = "WorkloadItemResource"

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

type

type: object

className

className: string = "WorkloadItemResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "WorkloadItem"

name

name: "Composite" = "Composite"

Const WorkloadItemResourceList

WorkloadItemResourceList: object
interface

An interface representing the WorkloadItemResourceList. List of WorkloadItem resources

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "WorkloadItemResourceList"

__@iterator

  • __@iterator(): IterableIterator<WorkloadItemResource>

  • Iterator

    Returns IterableIterator<WorkloadItemResource>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<WorkloadItemResource>[]): WorkloadItemResource[]
  • concat(...items: (T | ConcatArray<T>)[]): WorkloadItemResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<WorkloadItemResource>[]

      Additional items to add to the end of array1.

    Returns WorkloadItemResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns WorkloadItemResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, WorkloadItemResource]>

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, WorkloadItemResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: WorkloadItemResource, index: number, array: WorkloadItemResource[]): boolean

        • Parameters

          • value: WorkloadItemResource
          • index: number
          • array: WorkloadItemResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: WorkloadItemResource, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: WorkloadItemResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): WorkloadItemResource[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: WorkloadItemResource

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: WorkloadItemResource, index: number, array: WorkloadItemResource[]): boolean

        • Parameters

          • value: WorkloadItemResource
          • index: number
          • array: WorkloadItemResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: WorkloadItemResource, index: number, array: WorkloadItemResource[]): any

        • Parameters

          • value: WorkloadItemResource
          • index: number
          • array: WorkloadItemResource[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns WorkloadItemResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): WorkloadItemResource | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: WorkloadItemResource

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: WorkloadItemResource, index: number, obj: WorkloadItemResource[]): boolean

        • Parameters

          • this: void
          • value: WorkloadItemResource
          • index: number
          • obj: WorkloadItemResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: WorkloadItemResource, index: number, obj: WorkloadItemResource[]): boolean

        • Parameters

          • value: WorkloadItemResource
          • index: number
          • obj: WorkloadItemResource[]

          Returns boolean

    • Optional thisArg: any

    Returns WorkloadItemResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: WorkloadItemResource, index: number, obj: WorkloadItemResource[]): boolean

        • Parameters

          • value: WorkloadItemResource
          • index: number
          • obj: WorkloadItemResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: WorkloadItemResource, index: number, array: WorkloadItemResource[]): void

        • Parameters

          • value: WorkloadItemResource
          • index: number
          • array: WorkloadItemResource[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: WorkloadItemResource, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: WorkloadItemResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: WorkloadItemResource, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: WorkloadItemResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: WorkloadItemResource, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: WorkloadItemResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: WorkloadItemResource, index: number, array: WorkloadItemResource[]): U

        • Parameters

          • value: WorkloadItemResource
          • index: number
          • array: WorkloadItemResource[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): WorkloadItemResource | undefined

  • Removes the last element from an array and returns it.

    Returns WorkloadItemResource | undefined

push

  • push(...items: WorkloadItemResource[]): number

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: WorkloadItemResource[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): WorkloadItemResource
  • reduce(callbackfn: function, initialValue: WorkloadItemResource): WorkloadItemResource
  • reduce<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: WorkloadItemResource, currentValue: WorkloadItemResource, currentIndex: number, array: WorkloadItemResource[]): WorkloadItemResource

        • Parameters

          • previousValue: WorkloadItemResource
          • currentValue: WorkloadItemResource
          • currentIndex: number
          • array: WorkloadItemResource[]

          Returns WorkloadItemResource

    Returns WorkloadItemResource

  • Parameters

    • callbackfn: function
        • (previousValue: WorkloadItemResource, currentValue: WorkloadItemResource, currentIndex: number, array: WorkloadItemResource[]): WorkloadItemResource

        • Parameters

          • previousValue: WorkloadItemResource
          • currentValue: WorkloadItemResource
          • currentIndex: number
          • array: WorkloadItemResource[]

          Returns WorkloadItemResource

    • initialValue: WorkloadItemResource

    Returns WorkloadItemResource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: WorkloadItemResource, currentIndex: number, array: WorkloadItemResource[]): U

        • Parameters

          • previousValue: U
          • currentValue: WorkloadItemResource
          • currentIndex: number
          • array: WorkloadItemResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): WorkloadItemResource
  • reduceRight(callbackfn: function, initialValue: WorkloadItemResource): WorkloadItemResource
  • reduceRight<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: WorkloadItemResource, currentValue: WorkloadItemResource, currentIndex: number, array: WorkloadItemResource[]): WorkloadItemResource

        • Parameters

          • previousValue: WorkloadItemResource
          • currentValue: WorkloadItemResource
          • currentIndex: number
          • array: WorkloadItemResource[]

          Returns WorkloadItemResource

    Returns WorkloadItemResource

  • Parameters

    • callbackfn: function
        • (previousValue: WorkloadItemResource, currentValue: WorkloadItemResource, currentIndex: number, array: WorkloadItemResource[]): WorkloadItemResource

        • Parameters

          • previousValue: WorkloadItemResource
          • currentValue: WorkloadItemResource
          • currentIndex: number
          • array: WorkloadItemResource[]

          Returns WorkloadItemResource

    • initialValue: WorkloadItemResource

    Returns WorkloadItemResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: WorkloadItemResource, currentIndex: number, array: WorkloadItemResource[]): U

        • Parameters

          • previousValue: U
          • currentValue: WorkloadItemResource
          • currentIndex: number
          • array: WorkloadItemResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): WorkloadItemResource[]

  • Reverses the elements in an Array.

    Returns WorkloadItemResource[]

shift

  • shift(): WorkloadItemResource | undefined

  • Removes the first element from an array and returns it.

    Returns WorkloadItemResource | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): WorkloadItemResource[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns WorkloadItemResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: WorkloadItemResource, index: number, array: WorkloadItemResource[]): boolean

        • Parameters

          • value: WorkloadItemResource
          • index: number
          • array: WorkloadItemResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): WorkloadItemResource[]
  • splice(start: number, deleteCount: number, ...items: WorkloadItemResource[]): WorkloadItemResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns WorkloadItemResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: WorkloadItemResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns WorkloadItemResource[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: WorkloadItemResource[]): number

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: WorkloadItemResource[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<WorkloadItemResource>

  • Returns an iterable of values in the array

    Returns IterableIterator<WorkloadItemResource>

type

type: object

className

className: string = "WorkloadItemResourceList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "WorkloadItemResource"

name

name: "Composite" = "Composite"

Const WorkloadProtectableItem

WorkloadProtectableItem: object
interface

An interface representing WorkloadProtectableItem. Base class for backup item. Workload-specific backup items are derived from this class.

Optional backupManagementType

backupManagementType: undefined | string
member

{string} [backupManagementType] Type of backup managemenent to backup an item.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] Friendly name of the backup item.

protectableItemType

protectableItemType: "WorkloadProtectableItem"
member

{string} protectableItemType Polymorphic Discriminator

Optional protectionState

protectionState: ProtectionStatus
member

{ProtectionStatus} [protectionState] State of the back up item. Possible values include: 'Invalid', 'NotProtected', 'Protecting', 'Protected', 'ProtectionFailed'

serializedName

serializedName: string = "WorkloadProtectableItem"

Optional workloadType

workloadType: undefined | string
member

{string} [workloadType] Type of workload for the backup management

type

type: object

className

className: string = "WorkloadProtectableItem"

name

name: "Composite" = "Composite"

uberParent

uberParent: string = "WorkloadProtectableItem"

modelProperties

modelProperties: object

backupManagementType

backupManagementType: object

serializedName

serializedName: string = "backupManagementType"

type

type: object

name

name: "String" = "String"

friendlyName

friendlyName: object

serializedName

serializedName: string = "friendlyName"

type

type: object

name

name: "String" = "String"

protectableItemType

protectableItemType: object

required

required: true = true

serializedName

serializedName: string = "protectableItemType"

type

type: object

name

name: "String" = "String"

protectionState

protectionState: object

serializedName

serializedName: string = "protectionState"

type

type: object

name

name: "String" = "String"

workloadType

workloadType: object

serializedName

serializedName: string = "workloadType"

type

type: object

name

name: "String" = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "protectableItemType"

serializedName

serializedName: string = "protectableItemType"

Const WorkloadProtectableItemResource

WorkloadProtectableItemResource: object
interface

An interface representing WorkloadProtectableItemResource. Base class for backup item. Workload-specific backup items are derived from this class.

extends

Resource

Optional eTag

eTag: undefined | string
member

{string} [eTag] Optional ETag.

Optional id

id: undefined | string
member

{string} [id] Resource Id represents the complete path to the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string
member

{string} [location] Resource location.

Optional name

name: undefined | string
member

{string} [name] Resource name associated with the resource. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: WorkloadProtectableItemUnion
member

{WorkloadProtectableItemUnion} [properties] WorkloadProtectableItemResource properties

serializedName

serializedName: string = "WorkloadProtectableItemResource"

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] Resource tags.

type

type: object

className

className: string = "WorkloadProtectableItemResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "WorkloadProtectableItem"

name

name: "Composite" = "Composite"

Const WorkloadProtectableItemResourceList

WorkloadProtectableItemResourceList: object
interface

An interface representing the WorkloadProtectableItemResourceList. List of WorkloadProtectableItem resources

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "WorkloadProtectableItemResourceList"

__@iterator

  • __@iterator(): IterableIterator<WorkloadProtectableItemResource>

  • Iterator

    Returns IterableIterator<WorkloadProtectableItemResource>

__@unscopables

  • __@unscopables(): object

  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<WorkloadProtectableItemResource>[]): WorkloadProtectableItemResource[]
  • concat(...items: (T | ConcatArray<T>)[]): WorkloadProtectableItemResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<WorkloadProtectableItemResource>[]

      Additional items to add to the end of array1.

    Returns WorkloadProtectableItemResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns WorkloadProtectableItemResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this

  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, WorkloadProtectableItemResource]>

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, WorkloadProtectableItemResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: WorkloadProtectableItemResource, index: number, array: WorkloadProtectableItemResource[]): boolean

        • Parameters

          • value: WorkloadProtectableItemResource
          • index: number
          • array: WorkloadProtectableItemResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: WorkloadProtectableItemResource, start?: undefined | number, end?: undefined | number): this

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: WorkloadProtectableItemResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): WorkloadProtectableItemResource[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: WorkloadProtectableItemResource

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: WorkloadProtectableItemResource, index: number, array: WorkloadProtectableItemResource[]): boolean

        • Parameters

          • value: WorkloadProtectableItemResource
          • index: number
          • array: WorkloadProtectableItemResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: WorkloadProtectableItemResource, index: number, array: WorkloadProtectableItemResource[]): any

        • Parameters

          • value: WorkloadProtectableItemResource
          • index: number
          • array: WorkloadProtectableItemResource[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns WorkloadProtectableItemResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): WorkloadProtectableItemResource | undefined

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: WorkloadProtectableItemResource

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: WorkloadProtectableItemResource, index: number, obj: WorkloadProtectableItemResource[]): boolean

        • Parameters

          • this: void
          • value: WorkloadProtectableItemResource
          • index: number
          • obj: WorkloadProtectableItemResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: WorkloadProtectableItemResource, index: number, obj: WorkloadProtectableItemResource[]): boolean

        • Parameters

          • value: WorkloadProtectableItemResource
          • index: number
          • obj: WorkloadProtectableItemResource[]

          Returns boolean

    • Optional thisArg: any

    Returns WorkloadProtectableItemResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number

  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: WorkloadProtectableItemResource, index: number, obj: WorkloadProtectableItemResource[]): boolean

        • Parameters

          • value: WorkloadProtectableItemResource
          • index: number
          • obj: WorkloadProtectableItemResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: WorkloadProtectableItemResource, index: number, array: WorkloadProtectableItemResource[]): void

        • Parameters

          • value: WorkloadProtectableItemResource
          • index: number
          • array: WorkloadProtectableItemResource[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: WorkloadProtectableItemResource, fromIndex?: undefined | number): boolean

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: WorkloadProtectableItemResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: WorkloadProtectableItemResource, fromIndex?: undefined | number): number

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: WorkloadProtectableItemResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string

  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>

  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: WorkloadProtectableItemResource, fromIndex?: undefined | number): number

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: WorkloadProtectableItemResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]

  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: WorkloadProtectableItemResource, index: number, array: WorkloadProtectableItemResource[]): U

        • Parameters

          • value: WorkloadProtectableItemResource
          • index: number
          • array: WorkloadProtectableItemResource[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): WorkloadProtectableItemResource | undefined

  • Removes the last element from an array and returns it.

    Returns WorkloadProtectableItemResource | undefined

push

  • push(...items: WorkloadProtectableItemResource[]): number

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: WorkloadProtectableItemResource[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): WorkloadProtectableItemResource
  • reduce(callbackfn: function, initialValue: WorkloadProtectableItemResource): WorkloadProtectableItemResource
  • reduce<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: WorkloadProtectableItemResource, currentValue: WorkloadProtectableItemResource, currentIndex: number, array: WorkloadProtectableItemResource[]): WorkloadProtectableItemResource

        • Parameters

          • previousValue: WorkloadProtectableItemResource
          • currentValue: WorkloadProtectableItemResource
          • currentIndex: number
          • array: WorkloadProtectableItemResource[]

          Returns WorkloadProtectableItemResource

    Returns WorkloadProtectableItemResource

  • Parameters

    • callbackfn: function
        • (previousValue: WorkloadProtectableItemResource, currentValue: WorkloadProtectableItemResource, currentIndex: number, array: WorkloadProtectableItemResource[]): WorkloadProtectableItemResource

        • Parameters

          • previousValue: WorkloadProtectableItemResource
          • currentValue: WorkloadProtectableItemResource
          • currentIndex: number
          • array: WorkloadProtectableItemResource[]

          Returns WorkloadProtectableItemResource

    • initialValue: WorkloadProtectableItemResource

    Returns WorkloadProtectableItemResource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: WorkloadProtectableItemResource, currentIndex: number, array: WorkloadProtectableItemResource[]): U

        • Parameters

          • previousValue: U
          • currentValue: WorkloadProtectableItemResource
          • currentIndex: number
          • array: WorkloadProtectableItemResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): WorkloadProtectableItemResource
  • reduceRight(callbackfn: function, initialValue: WorkloadProtectableItemResource): WorkloadProtectableItemResource
  • reduceRight<U>(callbackfn: function, initialValue: U): U

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: WorkloadProtectableItemResource, currentValue: WorkloadProtectableItemResource, currentIndex: number, array: WorkloadProtectableItemResource[]): WorkloadProtectableItemResource

        • Parameters

          • previousValue: WorkloadProtectableItemResource
          • currentValue: WorkloadProtectableItemResource
          • currentIndex: number
          • array: WorkloadProtectableItemResource[]

          Returns WorkloadProtectableItemResource

    Returns WorkloadProtectableItemResource

  • Parameters

    • callbackfn: function
        • (previousValue: WorkloadProtectableItemResource, currentValue: WorkloadProtectableItemResource, currentIndex: number, array: WorkloadProtectableItemResource[]): WorkloadProtectableItemResource

        • Parameters

          • previousValue: WorkloadProtectableItemResource
          • currentValue: WorkloadProtectableItemResource
          • currentIndex: number
          • array: WorkloadProtectableItemResource[]

          Returns WorkloadProtectableItemResource

    • initialValue: WorkloadProtectableItemResource

    Returns WorkloadProtectableItemResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: WorkloadProtectableItemResource, currentIndex: number, array: WorkloadProtectableItemResource[]): U

        • Parameters

          • previousValue: U
          • currentValue: WorkloadProtectableItemResource
          • currentIndex: number
          • array: WorkloadProtectableItemResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): WorkloadProtectableItemResource[]

  • Reverses the elements in an Array.

    Returns WorkloadProtectableItemResource[]

shift

  • shift(): WorkloadProtectableItemResource | undefined

  • Removes the first element from an array and returns it.

    Returns WorkloadProtectableItemResource | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): WorkloadProtectableItemResource[]

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns WorkloadProtectableItemResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean

  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: WorkloadProtectableItemResource, index: number, array: WorkloadProtectableItemResource[]): boolean

        • Parameters

          • value: WorkloadProtectableItemResource
          • index: number
          • array: WorkloadProtectableItemResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): WorkloadProtectableItemResource[]
  • splice(start: number, deleteCount: number, ...items: WorkloadProtectableItemResource[]): WorkloadProtectableItemResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns WorkloadProtectableItemResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: WorkloadProtectableItemResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns WorkloadProtectableItemResource[]

toLocaleString

  • toLocaleString(): string

  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: WorkloadProtectableItemResource[]): number

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: WorkloadProtectableItemResource[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<WorkloadProtectableItemResource>

  • Returns an iterable of values in the array

    Returns IterableIterator<WorkloadProtectableItemResource>

type

type: object

className

className: string = "WorkloadProtectableItemResourceList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "WorkloadProtectableItemResource"

name

name: "Composite" = "Composite"

Const YearlyRetentionSchedule

YearlyRetentionSchedule: object
interface

An interface representing YearlyRetentionSchedule. Yearly retention schedule.

Optional monthsOfYear

monthsOfYear: MonthOfYear[]
member

{MonthOfYear[]} [monthsOfYear] List of months of year of yearly retention policy.

Optional retentionDuration

retentionDuration: RetentionDuration
member

{RetentionDuration} [retentionDuration] Retention duration of retention Policy.

Optional retentionScheduleDaily

retentionScheduleDaily: DailyRetentionFormat
member

{DailyRetentionFormat} [retentionScheduleDaily] Daily retention format for yearly retention policy.

Optional retentionScheduleFormatType

retentionScheduleFormatType: RetentionScheduleFormat
member

{RetentionScheduleFormat} [retentionScheduleFormatType] Retention schedule format for yearly retention policy. Possible values include: 'Invalid', 'Daily', 'Weekly'

Optional retentionScheduleWeekly

retentionScheduleWeekly: WeeklyRetentionFormat
member

{WeeklyRetentionFormat} [retentionScheduleWeekly] Weekly retention format for yearly retention policy.

Optional retentionTimes

retentionTimes: Date[] | string[]
member

{Date[] | string[]} [retentionTimes] Retention times of retention policy.

serializedName

serializedName: string = "YearlyRetentionSchedule"

type

type: object

className

className: string = "YearlyRetentionSchedule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

monthsOfYear

monthsOfYear: object

serializedName

serializedName: string = "monthsOfYear"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["Invalid","January","February","March","April","May","June","July","August","September","October","November","December"]

name

name: "Enum" = "Enum"

retentionDuration

retentionDuration: object

serializedName

serializedName: string = "retentionDuration"

type

type: object

className

className: string = "RetentionDuration"

name

name: "Composite" = "Composite"

retentionScheduleDaily

retentionScheduleDaily: object

serializedName

serializedName: string = "retentionScheduleDaily"

type

type: object

className

className: string = "DailyRetentionFormat"

name

name: "Composite" = "Composite"

retentionScheduleFormatType

retentionScheduleFormatType: object

serializedName

serializedName: string = "retentionScheduleFormatType"

type

type: object

name

name: "String" = "String"

retentionScheduleWeekly

retentionScheduleWeekly: object

serializedName

serializedName: string = "retentionScheduleWeekly"

type

type: object

className

className: string = "WeeklyRetentionFormat"

name

name: "Composite" = "Composite"

retentionTimes

retentionTimes: object

serializedName

serializedName: string = "retentionTimes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "DateTime" = "DateTime"

Const acceptLanguage

acceptLanguage: object

parameterPath

parameterPath: string = "acceptLanguage"

mapper

mapper: object

defaultValue

defaultValue: string = "en-US"

serializedName

serializedName: string = "accept-language"

type

type: object

name

name: "String" = "String"

Const apiVersion0

apiVersion0: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2017-07-01"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion1

apiVersion1: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2016-12-01"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const apiVersion2

apiVersion2: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2016-08-10"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const azureRegion

azureRegion: object

parameterPath

parameterPath: string = "azureRegion"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "azureRegion"

type

type: object

name

name: "String" = "String"

Const backupEngineName

backupEngineName: object

parameterPath

parameterPath: string = "backupEngineName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "backupEngineName"

type

type: object

name

name: "String" = "String"

Const containerName

containerName: object

parameterPath

parameterPath: string = "containerName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "containerName"

type

type: object

name

name: "String" = "String"

Const discriminators

discriminators: object

BackupEngineBase

BackupEngineBase: CompositeMapper = BackupEngineBase

BackupEngineBase.AzureBackupServerEngine

BackupEngineBase.AzureBackupServerEngine: CompositeMapper = AzureBackupServerEngine

BackupEngineBase.DpmBackupEngine

BackupEngineBase.DpmBackupEngine: CompositeMapper = DpmBackupEngine

BackupRequest

BackupRequest: CompositeMapper = BackupRequest

BackupRequest.AzureFileShareBackupRequest

BackupRequest.AzureFileShareBackupRequest: CompositeMapper = AzureFileShareBackupRequest

BackupRequest.AzureWorkloadBackupRequest

BackupRequest.AzureWorkloadBackupRequest: CompositeMapper = AzureWorkloadBackupRequest

BackupRequest.IaasVMBackupRequest

BackupRequest.IaasVMBackupRequest: CompositeMapper = IaasVMBackupRequest

FeatureSupportRequest

FeatureSupportRequest: CompositeMapper = FeatureSupportRequest

FeatureSupportRequest.AzureBackupGoals

FeatureSupportRequest.AzureBackupGoals: CompositeMapper = AzureBackupGoalFeatureSupportRequest

FeatureSupportRequest.AzureVMResourceBackup

FeatureSupportRequest.AzureVMResourceBackup: CompositeMapper = AzureVMResourceFeatureSupportRequest

ILRRequest

ILRRequest: CompositeMapper = ILRRequest

ILRRequest.IaasVMILRRegistrationRequest

ILRRequest.IaasVMILRRegistrationRequest: CompositeMapper = IaasVMILRRegistrationRequest

Job

Job: CompositeMapper = Job

Job.AzureIaaSVMJob

Job.AzureIaaSVMJob: CompositeMapper = AzureIaaSVMJob

Job.AzureStorageJob

Job.AzureStorageJob: CompositeMapper = AzureStorageJob

Job.AzureWorkloadJob

Job.AzureWorkloadJob: CompositeMapper = AzureWorkloadJob

Job.DpmJob

Job.DpmJob: CompositeMapper = DpmJob

Job.MabJob

Job.MabJob: CompositeMapper = MabJob

OperationResultInfoBase

OperationResultInfoBase: CompositeMapper = OperationResultInfoBase

OperationResultInfoBase.ExportJobsOperationResultInfo

OperationResultInfoBase.ExportJobsOperationResultInfo: CompositeMapper = ExportJobsOperationResultInfo

OperationResultInfoBase.OperationResultInfo

OperationResultInfoBase.OperationResultInfo: CompositeMapper = OperationResultInfo

OperationStatusExtendedInfo

OperationStatusExtendedInfo: CompositeMapper = OperationStatusExtendedInfo

OperationStatusExtendedInfo.OperationStatusJobExtendedInfo

OperationStatusExtendedInfo.OperationStatusJobExtendedInfo: CompositeMapper = OperationStatusJobExtendedInfo

OperationStatusExtendedInfo.OperationStatusJobsExtendedInfo

OperationStatusExtendedInfo.OperationStatusJobsExtendedInfo: CompositeMapper = OperationStatusJobsExtendedInfo

OperationStatusExtendedInfo.OperationStatusProvisionILRExtendedInfo

OperationStatusExtendedInfo.OperationStatusProvisionILRExtendedInfo: CompositeMapper = OperationStatusProvisionILRExtendedInfo

ProtectableContainer

ProtectableContainer: CompositeMapper = ProtectableContainer

ProtectableContainer.StorageContainer

ProtectableContainer.StorageContainer: CompositeMapper = AzureStorageProtectableContainer

ProtectableContainer.VMAppContainer

ProtectableContainer.VMAppContainer: CompositeMapper = AzureVMAppContainerProtectableContainer

ProtectedItem

ProtectedItem: CompositeMapper = ProtectedItem

ProtectedItem.AzureFileShareProtectedItem

ProtectedItem.AzureFileShareProtectedItem: CompositeMapper = AzureFileshareProtectedItem

ProtectedItem.AzureIaaSVMProtectedItem

ProtectedItem.AzureIaaSVMProtectedItem: CompositeMapper = AzureIaaSVMProtectedItem

ProtectedItem.AzureVmWorkloadProtectedItem

ProtectedItem.AzureVmWorkloadProtectedItem: CompositeMapper = AzureVmWorkloadProtectedItem

ProtectedItem.AzureVmWorkloadSAPHanaDatabase

ProtectedItem.AzureVmWorkloadSAPHanaDatabase: CompositeMapper = AzureVmWorkloadSAPHanaDatabaseProtectedItem

ProtectedItem.AzureVmWorkloadSQLDatabase

ProtectedItem.AzureVmWorkloadSQLDatabase: CompositeMapper = AzureVmWorkloadSQLDatabaseProtectedItem

ProtectedItem.DPMProtectedItem

ProtectedItem.DPMProtectedItem: CompositeMapper = DPMProtectedItem

ProtectedItem.GenericProtectedItem

ProtectedItem.GenericProtectedItem: CompositeMapper = GenericProtectedItem

ProtectedItem.MabFileFolderProtectedItem

ProtectedItem.MabFileFolderProtectedItem: CompositeMapper = MabFileFolderProtectedItem

ProtectedItem.Microsoft.ClassicCompute/virtualMachines

ProtectedItem.Microsoft.ClassicCompute/virtualMachines: CompositeMapper = AzureIaaSClassicComputeVMProtectedItem

ProtectedItem.Microsoft.Compute/virtualMachines

ProtectedItem.Microsoft.Compute/virtualMachines: CompositeMapper = AzureIaaSComputeVMProtectedItem

ProtectedItem.Microsoft.Sql/servers/databases

ProtectedItem.Microsoft.Sql/servers/databases: CompositeMapper = AzureSqlProtectedItem

ProtectionContainer

ProtectionContainer: CompositeMapper = ProtectionContainer

ProtectionContainer.AzureBackupServerContainer

ProtectionContainer.AzureBackupServerContainer: CompositeMapper = AzureBackupServerContainer

ProtectionContainer.AzureSqlContainer

ProtectionContainer.AzureSqlContainer: CompositeMapper = AzureSqlContainer

ProtectionContainer.AzureWorkloadBackupRequest

ProtectionContainer.AzureWorkloadBackupRequest: CompositeMapper = AzureWorkloadContainer

ProtectionContainer.DPMContainer

ProtectionContainer.DPMContainer: CompositeMapper = DpmContainer

ProtectionContainer.GenericContainer

ProtectionContainer.GenericContainer: CompositeMapper = GenericContainer

ProtectionContainer.IaaSVMContainer

ProtectionContainer.IaaSVMContainer: CompositeMapper = IaaSVMContainer

ProtectionContainer.Microsoft.ClassicCompute/virtualMachines

ProtectionContainer.Microsoft.ClassicCompute/virtualMachines: CompositeMapper = AzureIaaSClassicComputeVMContainer

ProtectionContainer.Microsoft.Compute/virtualMachines

ProtectionContainer.Microsoft.Compute/virtualMachines: CompositeMapper = AzureIaaSComputeVMContainer

ProtectionContainer.SQLAGWorkLoadContainer

ProtectionContainer.SQLAGWorkLoadContainer: CompositeMapper = AzureSQLAGWorkloadContainerProtectionContainer

ProtectionContainer.StorageContainer

ProtectionContainer.StorageContainer: CompositeMapper = AzureStorageContainer

ProtectionContainer.VMAppContainer

ProtectionContainer.VMAppContainer: CompositeMapper = AzureVMAppContainerProtectionContainer

ProtectionContainer.Windows

ProtectionContainer.Windows: CompositeMapper = MabContainer

ProtectionIntent

ProtectionIntent: CompositeMapper = ProtectionIntent

ProtectionIntent.AzureResourceItem

ProtectionIntent.AzureResourceItem: CompositeMapper = AzureResourceProtectionIntent

ProtectionIntent.AzureWorkloadAutoProtectionIntent

ProtectionIntent.AzureWorkloadAutoProtectionIntent: CompositeMapper = AzureWorkloadAutoProtectionIntent

ProtectionIntent.AzureWorkloadSQLAutoProtectionIntent

ProtectionIntent.AzureWorkloadSQLAutoProtectionIntent: CompositeMapper = AzureWorkloadSQLAutoProtectionIntent

ProtectionIntent.RecoveryServiceVaultItem

ProtectionIntent.RecoveryServiceVaultItem: CompositeMapper = AzureRecoveryServiceVaultProtectionIntent

ProtectionPolicy

ProtectionPolicy: CompositeMapper = ProtectionPolicy

ProtectionPolicy.AzureIaasVM

ProtectionPolicy.AzureIaasVM: CompositeMapper = AzureIaaSVMProtectionPolicy

ProtectionPolicy.AzureSql

ProtectionPolicy.AzureSql: CompositeMapper = AzureSqlProtectionPolicy

ProtectionPolicy.AzureStorage

ProtectionPolicy.AzureStorage: CompositeMapper = AzureFileShareProtectionPolicy

ProtectionPolicy.AzureWorkload

ProtectionPolicy.AzureWorkload: CompositeMapper = AzureVmWorkloadProtectionPolicy

ProtectionPolicy.GenericProtectionPolicy

ProtectionPolicy.GenericProtectionPolicy: CompositeMapper = GenericProtectionPolicy

ProtectionPolicy.MAB

ProtectionPolicy.MAB: CompositeMapper = MabProtectionPolicy

RecoveryPoint

RecoveryPoint: CompositeMapper = RecoveryPoint

RecoveryPoint.AzureFileShareRecoveryPoint

RecoveryPoint.AzureFileShareRecoveryPoint: CompositeMapper = AzureFileShareRecoveryPoint

RecoveryPoint.AzureWorkloadRecoveryPoint

RecoveryPoint.AzureWorkloadRecoveryPoint: CompositeMapper = AzureWorkloadRecoveryPoint

RecoveryPoint.AzureWorkloadSAPHanaPointInTimeRecoveryPoint

RecoveryPoint.AzureWorkloadSAPHanaPointInTimeRecoveryPoint: CompositeMapper = AzureWorkloadSAPHanaPointInTimeRecoveryPoint

RecoveryPoint.AzureWorkloadSAPHanaRecoveryPoint

RecoveryPoint.AzureWorkloadSAPHanaRecoveryPoint: CompositeMapper = AzureWorkloadSAPHanaRecoveryPoint

RecoveryPoint.AzureWorkloadSQLPointInTimeRecoveryPoint

RecoveryPoint.AzureWorkloadSQLPointInTimeRecoveryPoint: CompositeMapper = AzureWorkloadSQLPointInTimeRecoveryPoint

RecoveryPoint.AzureWorkloadSQLRecoveryPoint

RecoveryPoint.AzureWorkloadSQLRecoveryPoint: CompositeMapper = AzureWorkloadSQLRecoveryPoint

RecoveryPoint.GenericRecoveryPoint

RecoveryPoint.GenericRecoveryPoint: CompositeMapper = GenericRecoveryPoint

RecoveryPoint.IaasVMRecoveryPoint

RecoveryPoint.IaasVMRecoveryPoint: CompositeMapper = IaasVMRecoveryPoint

RestoreRequest

RestoreRequest: CompositeMapper = RestoreRequest

RestoreRequest.AzureFileShareRestoreRequest

RestoreRequest.AzureFileShareRestoreRequest: CompositeMapper = AzureFileShareRestoreRequest

RestoreRequest.AzureWorkloadRestoreRequest

RestoreRequest.AzureWorkloadRestoreRequest: CompositeMapper = AzureWorkloadRestoreRequest

RestoreRequest.AzureWorkloadSAPHanaPointInTimeRestoreRequest

RestoreRequest.AzureWorkloadSAPHanaPointInTimeRestoreRequest: CompositeMapper = AzureWorkloadSAPHanaPointInTimeRestoreRequest

RestoreRequest.AzureWorkloadSAPHanaRestoreRequest

RestoreRequest.AzureWorkloadSAPHanaRestoreRequest: CompositeMapper = AzureWorkloadSAPHanaRestoreRequest

RestoreRequest.AzureWorkloadSQLPointInTimeRestoreRequest

RestoreRequest.AzureWorkloadSQLPointInTimeRestoreRequest: CompositeMapper = AzureWorkloadSQLPointInTimeRestoreRequest

RestoreRequest.AzureWorkloadSQLRestoreRequest

RestoreRequest.AzureWorkloadSQLRestoreRequest: CompositeMapper = AzureWorkloadSQLRestoreRequest

RestoreRequest.IaasVMRestoreRequest

RestoreRequest.IaasVMRestoreRequest: CompositeMapper = IaasVMRestoreRequest

RetentionPolicy

RetentionPolicy: CompositeMapper = RetentionPolicy

RetentionPolicy.LongTermRetentionPolicy

RetentionPolicy.LongTermRetentionPolicy: CompositeMapper = LongTermRetentionPolicy

RetentionPolicy.SimpleRetentionPolicy

RetentionPolicy.SimpleRetentionPolicy: CompositeMapper = SimpleRetentionPolicy

SchedulePolicy

SchedulePolicy: CompositeMapper = SchedulePolicy

SchedulePolicy.LogSchedulePolicy

SchedulePolicy.LogSchedulePolicy: CompositeMapper = LogSchedulePolicy

SchedulePolicy.LongTermSchedulePolicy

SchedulePolicy.LongTermSchedulePolicy: CompositeMapper = LongTermSchedulePolicy

SchedulePolicy.SimpleSchedulePolicy

SchedulePolicy.SimpleSchedulePolicy: CompositeMapper = SimpleSchedulePolicy

ValidateOperationRequest

ValidateOperationRequest: CompositeMapper = ValidateOperationRequest

ValidateOperationRequest.ValidateIaasVMRestoreOperationRequest

ValidateOperationRequest.ValidateIaasVMRestoreOperationRequest: CompositeMapper = ValidateIaasVMRestoreOperationRequest

ValidateOperationRequest.ValidateRestoreOperationRequest

ValidateOperationRequest.ValidateRestoreOperationRequest: CompositeMapper = ValidateRestoreOperationRequest

WorkloadItem

WorkloadItem: CompositeMapper = WorkloadItem

WorkloadItem.AzureVmWorkloadItem

WorkloadItem.AzureVmWorkloadItem: CompositeMapper = AzureVmWorkloadItem

WorkloadItem.SAPHanaDatabase

WorkloadItem.SAPHanaDatabase: CompositeMapper = AzureVmWorkloadSAPHanaDatabaseWorkloadItem

WorkloadItem.SAPHanaSystem

WorkloadItem.SAPHanaSystem: CompositeMapper = AzureVmWorkloadSAPHanaSystemWorkloadItem

WorkloadItem.SQLDataBase

WorkloadItem.SQLDataBase: CompositeMapper = AzureVmWorkloadSQLDatabaseWorkloadItem

WorkloadItem.SQLInstance

WorkloadItem.SQLInstance: CompositeMapper = AzureVmWorkloadSQLInstanceWorkloadItem

WorkloadProtectableItem

WorkloadProtectableItem: CompositeMapper = WorkloadProtectableItem

WorkloadProtectableItem.AzureFileShare

WorkloadProtectableItem.AzureFileShare: CompositeMapper = AzureFileShareProtectableItem

WorkloadProtectableItem.AzureVmWorkloadProtectableItem

WorkloadProtectableItem.AzureVmWorkloadProtectableItem: CompositeMapper = AzureVmWorkloadProtectableItem

WorkloadProtectableItem.IaaSVMProtectableItem

WorkloadProtectableItem.IaaSVMProtectableItem: CompositeMapper = IaaSVMProtectableItem

WorkloadProtectableItem.Microsoft.ClassicCompute/virtualMachines

WorkloadProtectableItem.Microsoft.ClassicCompute/virtualMachines: CompositeMapper = AzureIaaSClassicComputeVMProtectableItem

WorkloadProtectableItem.Microsoft.Compute/virtualMachines

WorkloadProtectableItem.Microsoft.Compute/virtualMachines: CompositeMapper = AzureIaaSComputeVMProtectableItem

WorkloadProtectableItem.SAPHanaDatabase

WorkloadProtectableItem.SAPHanaDatabase: CompositeMapper = AzureVmWorkloadSAPHanaDatabaseProtectableItem

WorkloadProtectableItem.SAPHanaSystem

WorkloadProtectableItem.SAPHanaSystem: CompositeMapper = AzureVmWorkloadSAPHanaSystemProtectableItem

WorkloadProtectableItem.SQLAvailabilityGroupContainer

WorkloadProtectableItem.SQLAvailabilityGroupContainer: CompositeMapper = AzureVmWorkloadSQLAvailabilityGroupProtectableItem

WorkloadProtectableItem.SQLDataBase

WorkloadProtectableItem.SQLDataBase: CompositeMapper = AzureVmWorkloadSQLDatabaseProtectableItem

WorkloadProtectableItem.SQLInstance

WorkloadProtectableItem.SQLInstance: CompositeMapper = AzureVmWorkloadSQLInstanceProtectableItem

Const fabricName

fabricName: object

parameterPath

parameterPath: string = "fabricName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "fabricName"

type

type: object

name

name: "String" = "String"

Const filter

filter: object

parameterPath

parameterPath: string[] = ["options","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const intentObjectName

intentObjectName: object

parameterPath

parameterPath: string = "intentObjectName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "intentObjectName"

type

type: object

name

name: "String" = "String"

Const jobName

jobName: object

parameterPath

parameterPath: string = "jobName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "jobName"

type

type: object

name

name: "String" = "String"

Const nextPageLink

nextPageLink: object

parameterPath

parameterPath: string = "nextPageLink"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

Const operationId

operationId: object

parameterPath

parameterPath: string = "operationId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "operationId"

type

type: object

name

name: "String" = "String"

Const policyName

policyName: object

parameterPath

parameterPath: string = "policyName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "policyName"

type

type: object

name

name: "String" = "String"

Const protectedItemName

protectedItemName: object

parameterPath

parameterPath: string = "protectedItemName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "protectedItemName"

type

type: object

name

name: "String" = "String"

Const recoveryPointId

recoveryPointId: object

parameterPath

parameterPath: string = "recoveryPointId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "recoveryPointId"

type

type: object

name

name: "String" = "String"

Const resourceGroupName

resourceGroupName: object

parameterPath

parameterPath: string = "resourceGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "resourceGroupName"

type

type: object

name

name: "String" = "String"

Const skipToken

skipToken: object

parameterPath

parameterPath: string[] = ["options","skipToken"]

mapper

mapper: object

serializedName

serializedName: string = "$skipToken"

type

type: object

name

name: "String" = "String"

Const subscriptionId

subscriptionId: object

parameterPath

parameterPath: string = "subscriptionId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

Const vaultName

vaultName: object

parameterPath

parameterPath: string = "vaultName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "vaultName"

type

type: object

name

name: "String" = "String"

Generated using TypeDoc